Miosix Wiki - User contributions [en]

Main Page

2016-12-17T20:27:52Z

Silseva:

Welcome to the Miosix wiki. This wiki contains the documentation for the Miosix kernel.

<br><div style="background-color:#FFA0A0;">
IMPORTANT NOTICE: <br>
Recently ST Microeletronics has changed the firmware used for ST-LINK utility on its Discovery boards. For this reason, if you have bought a STM32 Discovery board recently, it's highly possible that you may encounter problems in uploading your firmware using the Qstlink GUI utility. <br>
Until an update of the Qstlink utility is released (which not depends upon us), in [[ST-LINK utility update|this page]] you can find a temporary fix for this issue.
</div><br>

= Getting started =
Follow the [[Quick start]] to install the Miosix Toolchain and compile the Miosix 2.0 kernel.

= Software =
* Have a look at the Miosix [[API list|APIs]] and [[Library list|libraries]] that you can use for your applications.
* The page on [[Synchronization primitives]] lists the possible ways to shnchronize beween multiple threads or between a thread and an interrupt routine.
* How to [[Miosix code size optimization|reduce the kernel code size]] for deeply embedded applications.

= Hardware =
Check out which microcontroller [[Board list|boards]] are supported by Miosix.

= Account creation =
Due to spam (within two days from setting up the wiki) account registration is disabled. If you want to create an account, ask to fede.tft&&miosix.org (s/&&/@/)

= Index =
* [[Special:Categories|Categories]]
* [[Special:AllPages|All Pages]]

Main Page

2016-12-17T20:26:25Z

Silseva:

Welcome to the Miosix wiki. This wiki contains the documentation for the Miosix kernel.

<br><div style="background-color:#FFA0A0;">
IMPORTANT NOTICE: <br>
Recently ST Microeletronics has changed the firmware used for ST-LINK utility on its Discovery boards. For this reason, if you have bought a STM32 Discovery board recently, it's highly possible that you may encounter problems in uploading your firmware using the Qstlink GUI utility. <br>
Until an update of the Qstlink utility is released (which not depends upon us), in [[New ST-LINK firmware|this page]] you can find a temporary fix for this issue.
</div><br>

= Getting started =
Follow the [[Quick start]] to install the Miosix Toolchain and compile the Miosix 2.0 kernel.

= Software =
* Have a look at the Miosix [[API list|APIs]] and [[Library list|libraries]] that you can use for your applications.
* The page on [[Synchronization primitives]] lists the possible ways to shnchronize beween multiple threads or between a thread and an interrupt routine.
* How to [[Miosix code size optimization|reduce the kernel code size]] for deeply embedded applications.

= Hardware =
Check out which microcontroller [[Board list|boards]] are supported by Miosix.

= Account creation =
Due to spam (within two days from setting up the wiki) account registration is disabled. If you want to create an account, ask to fede.tft&&miosix.org (s/&&/@/)

= Index =
* [[Special:Categories|Categories]]
* [[Special:AllPages|All Pages]]

MacOS Quick Start

2016-12-16T08:49:44Z

Silseva:

ATTENTION: This page is still a WIP. Usual disclaimers about not taking responsibility for your system disruption applies.

=== Before you begin ===

This procedure has been tested on OS X El Capitain 10.11. The Miosix toolchain has been successfully compiled using GCC 4.9.3, which can be installed using the Homebrew package manager.

'''Install Xcode'''

Install Xcode by downloading it from the Mac App Store [https://itunes.apple.com/au/app/xcode/id497799835?mt=12 here]. This is needed for installing the XCode command line tools which in turn is needed by Homebrew.

'''Install Xcode Command Line Tools'''

Install the Command Line Tools by running the following command in terminal:

<source lang="bash">
xcode-select --install
</source>

It is recommended to run the command even if Xcode and the Command Line Tools were already installed on your system, since the Command Line Tools installation may have been messed up by upgrading to 10.11 from a previous release.

'''Install Homebrew'''

Grab a copy of Homebrew and run the install script in one step using this command in terminal:

<source lang="bash">
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
</source>

If it complains about permission issues, then you have to fix it before you can continue. In Mac OS X El Capitan 10.11, Apple introduced a new feature called System Integrity Protector (SIP), which prevents from writing to many system directories such as /usr, /System, /bin, regardless of whether or not you are root. Apple is leaving /usr/local open for developers to use, so Homebrew can still be used as expected; however, performing a few steps may be required depending on you system, as outlined in the official Homebrew documentation [https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/El_Capitan_and_Homebrew.md here].

=== System dependencies installation ===

'''Install GNU tar'''

Running the Miosix toolchain compilation script may give you an error related to extracting a file. Therefore, using GNU tar instead of Apple tar is suggested.

Run this command in terminal to add the repository containing GNU tar to Homebrew:

<source lang="bash">
brew tap homebrew/dupes
</source>

Run this command in terminal to grab the most recent packages list from Homebrew:

<source lang="bash">
brew update
</source>

Run this command to install GNU tar:

<source lang="bash">
brew install gnu-tar
</source>

'''Install GCC 4.9.3'''

Running the Miosix toolchain compilation script using Apple GCC has proven unsuccessful. That's why we need to install GCC 4.9.3 from Homebrew. Perform the steps below:

Run this command in terminal to add the repository containing GCC 4.9.3 to Homebrew:

<source lang="bash">
brew tap homebrew/versions
</source>

Run this command in terminal to grab the most recent packages list from Homebrew:

<source lang="bash">
brew update
</source>

Run this command to install GCC 4.9.3:

<source lang="bash">
brew install gcc49
</source>

'''Symlink GCC 4.9.3 executables'''

First, you need to create appropriate symlinks within /usr/local/bin from the versioned name of gcc executables to generic ones. Run these commands from terminal:

<source lang="bash">
ln -s /usr/local/bin/gcc-4.9 /usr/local/bin/gcc
ln -s /usr/local/bin/gcc-4.9 /usr/local/bin/cc
ln -s /usr/local/bin/g++-4.9 /usr/local/bin/g++
ln -s /usr/local/bin/cpp-4.9 /usr/local/bin/cpp
ln -s /usr/local/bin/c++-4.9 /usr/local/bin/c++
</source>

Please notice that gcc-4.9 has not been symlinked to ld has someone may expect, since it has proven prone to errors during the Miosix toolchain compilation. Instead, we are gonna use Apple own Clang ld as a linker.

'''Edit $PATH variable'''

Now you need to make sure that /usr/local/bin gets inspected before /usr/bin when looking for gcc, so that Homebrew GCC 4.9.3 will be called instead of Apple GCC. In order to do so, we are gonna modify the $PATH terminal variable. Run from terminal:

<source lang="bash">
cd
</source>

To get into your home folder.

Run from terminal:

<source lang="bash">
edit .bash_profile
</source>

To edit the bash profile script.

You need to add the following lines as they are:

<source lang="bash">
#homebrew gcc
export PATH=/usr/local/bin:$PATH
#gnu-tar
export PATH=/usr/local/opt/gnu-tar/libexec/gnubin:$PATH
</source>

Save and close the file.

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

'''Check the installed packages'''

If everything went as supposed, running from terminal:

<source lang="bash">
gcc -v
</source>

should return some text including:

<source lang="bash">
gcc version 4.9.3 (Homebrew gcc49 4.9.3)
</source>

While running from terminal:

<source lang="bash">
ld -v
</source>

should return some text including:

<source lang="bash">
LTO support using: Apple LLVM 7.0.0
</source>

And finally running from terminal:

<source lang="bash">
tar --version
</source>

should return some text including:

<source lang="bash">
tar (GNU tar)
</source>

=== Toolchain compilation and installation ===

'''Toolchain sources download'''

In order to download the kernel and toolchains sources, you need git. If you don't have it already, you can install it using Homebrew:

<source lang="bash">
brew install git
</source>

From terminal, cd to a folder of your choice, making sure that the path from root to it doesn't contain spaces or special characters. Then run:

<source lang="bash">
git clone https://miosix.org/git-public/miosix-kernel.git
cd miosix-kernel
git fetch origin
## To select the development version of the kernel
#git checkout -b testing origin/testing
</source>

Please note that currently, the ''master'' branch contains the stable 2.0 kernel, while the ''testing'' branch contains the current development version. Usually the latter contains the latest updates made, especially support packages for new boards, so its advised to use the code contained in this branch.

'''Toolchain dependencies download'''

You need to fix a link in the Miosix toolchain dependencies download script, located at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/download.sh
</source>

Replace the following line:

<source lang="bash">
wget http://www.mpfr.org/mpfr-current/mpfr-3.1.2.tar.xz
</source>

with:

<source lang="bash">
wget http://www.mpfr.org/mpfr-3.1.2/mpfr-3.1.2.tar.xz
</source>

Now you need to run the dependencies download script. From terminal, run:

<source lang="bash">
sh miosix-kernel/miosix/_tools/compiler/download.sh
</source>

from the folder where you performed the git clone command.

'''Toolchain compilation'''

System-wide installation of the toolchain is currently untested. It is then suggested to install it locally and then add its location the the $PATH.
First, edit the install script located at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/install-script.sh
</source>

such that at the end the first few lines looks as follow:

<source lang="bash">
# Uncomment if installing globally on the system
#INSTALL_DIR=/opt
#SUDO=sudo
# Uncomment if installing locally, sudo isn't necessary
INSTALL_DIR=`pwd`/gcc
SUDO=
</source>

We can now finally run the compilation script. From terminal, run:

<source lang="bash">
sh miosix-kernel/miosix/_tools/compiler/install-script.sh
</source>

At the end, if everything worked correctly, you'll find the toolchain at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/gcc/arm-miosix-eabi/bin
</source>

'''Toolchain compilation and installation'''

Now you need to add the toolchain to your path. Edit the bash profile script and add the following lines:

<source lang="bash">
#arm-miosix-eabi
export PATH={my-folder-of-choice-path}/miosix-kernel/miosix/_tools/compiler/gcc/arm-miosix-eabi/bin:$PATH
</source>

where you have to replace {my-folder-of-choice-path} with the path of the folder where you run the git clone command.

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

'''Cleanup'''

You are now free to go back to Apple tar and GCC. In order to do so, edit the bash profile script and remove the following lines:

<source lang="bash">
#homebrew gcc
export PATH=/usr/local/bin:$PATH
#gnu-tar
export PATH=/usr/local/opt/gnu-tar/libexec/gnubin:$PATH
</source>

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

=== Kernel compilation ===

In order to configure and compile the kernel, please follow the steps outlined in the [[Linux Quick Start|Linux Quick Start]].

=== Flash and debug an STM32F4DISCOVERY board ===

'''Tools installation'''

In order to be able to flash and debug an STM32F4DISCOVERY board, you need the stlink tools suite. You can grab it from Homebrew running:

<source lang="bash">
brew install stlink
</source>

Lastly, if you have a brand new board and QSTlink doesn't work you may take a look at [[ST-LINK utility update|this page]].

Windows Quick Start

2016-12-16T08:48:34Z

Silseva:

=== Before you begin ===

Before you can install the Miosix Toolchain on Windows, you will need to install [https://en.wikipedia.org/wiki/Git_%28software%29 git], which is necessary to download the Miosix kernel and keep it up to date, [https://en.wikipedia.org/wiki/Perl Perl], which is a scripting language used when compiling the kernel, and the STLink drivers if you want to program stm32 boards that have an USB-based STLinkV2 programmer/debugger.

* For git, it is recomended to install it from [http://www.git-scm.com/download/win git-scm.com]. Please '''do not''' uncheck the ''Windows Explorer integration'' feature during the installation, as you will need it to install the kernel sources.
* [http://strawberryperl.com Strawberry perl] is the recomended perl version for Miosix on Windows
* The STLink drivers can be found on the [http://www.st.com/web/en/catalog/tools/PF258168# ST website].

Finally, it is recomended to download a better text editor than Notepad or WordPad, as you will need it to edit the Miosix configuration files. [http://www.notepad-plus-plus.org/ Notepad++] is a good option, but many other options exist. Just '''don't use notepad''', because it does not recognize Unix [https://en.wikipedia.org/wiki/Line_ending line-endings] and will show you Miosix source files as if they were composed of a single line of text.

Once you have downloaded and installed the aforementioned software, you can proceed with the installation of the Miosix Toolchain.

=== Install the Miosix Toolchain ===

Download the [[Miosix Toolchain]] and run it. At the end you will need to reboot your computer (sorry, it's Windows...)

=== Get the Miosix kernel sources ===

Go to the directory where you want to dowload the Miosix kernel, for example the Documents directory, and right-click on it. Select ''Git bash'' to open a git shell. There you can type the commands to download the kernel.

[[File:Gitbashwindows.png]]

The Miosix git repository used to be hosted at [http://gitorious.org gitorious.org], but the service was shut down. For this reason, the kernel is now hosted directly at miosix.org. There is also a [https://github.com/fedetft/miosix-kernel github mirror] and the two repositories will be always kept in sync. Currently, the ''master'' branch contains the stable 2.0 kernel, while the ''testing'' branch contains the current development version. Kernel versions prior to 2.0 are deprecated.

<source lang="bash">
git clone https://miosix.org/git-public/miosix-kernel.git
cd miosix-kernel
git fetch origin
## To select the development version of the kernel
#git checkout -b testing origin/testing
exit
</source>

Note that it is possible to paste commands in the shell (so as to avoid typing them, which can be tedious and lead to typos), but you have to do it one line of text at a time, and to paste you need to use the ''Shift+Ins'' shortcut, not the usual ''Ctrl+v'' one. The last command, ''exit'', will close the shell.

Note that there is also a 'Git GUI' in the right click menu, but since I don't know how to use it, you're on your own if you choose that route.

=== Configuring and compiling the kernel ===

More in-depth information on how th configure the kernel for your board can be found in the [[Board list]], but for now we will assume you have an stm32f4discovery, which is a common board, and briefly show how to get to a blinking LED example.

'''Top-level directory'''

First of all the miosix-kernel directory is often referred to as the '''top-level directory''' of the kernel. It contains, among other, the ''main.cpp'' file which is where you can start writing your application code, the ''Makefile'' where you can add additional C++ and C source files to be compiled, and the ''miosix'' directory which contains the kernel.

[[File:Miosixtopleveldirectorywindows.png]]

All paths in this wiki, unless they start with a '/' (for Linux) or 'C:\' (For Windows), are intended relative to Miosix's top-level directory, so if we're talking about the 'miosix/config/Makefile.inc' file you can find it within the directory where you have downloaded the kernel from git.

'''Configuring the kernel'''

The kernel is configured by editing two files, named [[Makefile.inc|miosix/config/Makefile.inc]] and [[miosix_settingls.h|miosix/config/miosix_settings.h]]. Open the first one in Notepad++, and select your board. To do so, look for the ''OPT_BOARD'' section of the file, which looks like this:

<source lang="bash">
##
## Target board, choose one. This also implicitly select the target
## architecture
##
#OPT_BOARD := lpc2138_miosix_board
OPT_BOARD := stm32f103ze_stm3210e-eval
#OPT_BOARD := stm32f103ve_mp3v2
#OPT_BOARD := stm32f100rb_stm32vldiscovery
#OPT_BOARD := stm32f103ve_strive_mini
#OPT_BOARD := stm32f103ze_redbull_v2
#OPT_BOARD := stm32f407vg_stm32f4discovery
#OPT_BOARD := stm32f207ig_stm3220g-eval
#OPT_BOARD := stm32f207zg_ethboard_v2
#OPT_BOARD := stm32f207ze_als_camboard
#OPT_BOARD := stm32l151_als_mainboard
#OPT_BOARD := stm32f407vg_bitsboard
#OPT_BOARD := stm32f205rg_sony-newman
</source>
In Makefile syntax a '#' sign denotes a comment, so to select a board you have to comment out (by prepending a '#') the default board selected, and uncomment (by removing the '#' at the start of the line) your board, which in this example is the ''stm32f407vg_stm32f4discovery''.

Next, edit the ''miosix_settings.h'' file using Notepad++ and uncomment (by removing the '//' at the start of the line) the following line
<source lang="CPP">
//#define JTAG_DISABLE_SLEEP
</source>
(which is towards the end of the file). This is a C++ header file, so the comment syntax is '//'. More information on the meaning of this line can be found in [[miosix_settings.h]], but a short summary is that this line prevents the kernel from shutting down the CPU when it has nothing to do, which saves power but interferes with the programming/debugging protocol used to program the board via QSTLink2.

Also, comment out the ''#error'' line towards the beginning of the file. This line exists to cause a compilation error if the user forgets to edit the ''miosix_settings.h'' file. The result should look like this:
<source lang="CPP">
// Before you can compile the kernel you have to configure it by editing this
// file. After that, comment out this line to disable the reminder error.
// The PARSING_FROM_IDE is because Netbeans gets confused by this, it is never
// defined when compiling the code.
#ifndef PARSING_FROM_IDE
//#error This error is a reminder that you have not edited miosix_settings.h yet.
#endif //PARSING_FROM_IDE
</source>

'''Blink a LED'''

Open the ''main.cpp'' file in the top-level directory using Notepad++, and replace its content with the following program:
<source lang="CPP">
#include <miosix.h>
using namespace miosix;
int main()
{
for(;;)
{
ledOn();
Thread::sleep(1000);
ledOff();
Thread::sleep(1000);
}
}
</source>
The Miosix board support package defines the ''ledOn()'' and ''ledOff()'' functions to control a LED on the board for all the boards that have at least one software-accessible LED.

'''Compiling'''

To compile the kernel, open a DOS shell in the Miosix top-level directory (you can 'Shift+Right click' in the top-level directory and choose 'Open command window here' in modern versions of Windows), otherwise you will have to ''cd'' your way into that directory.

[[File:Openterminalwindows.png]]

To compile the kernel type ''make'' in the DOS prompt. If all goes well, the result should look like this.

[[File:Makeoutputwindows.png]]

Otherwise, compiler errors will appear in the DOS prompt. The number that appears under ''text'' in the make output is the size in bytes of your application plus the kernel. If you think that 90KBytes is a bit too much for a blinking led, don't worry. The kernel by default includes support for C stdio functions, filesystem code including Unicode support and the C++ exception handling runtime, all of which can be disabled to significantly [[Miosix code size optimization|reduce code size]].

'''Programming'''

There are two ways to program the stm32f4discovery board. One is to use QSTLink2 directly from the DOS prompt you already have open by typing 'make program' (connect the USB cable first!), the other is through QSTLink2's GUI. You can find QSTLink2 in the start menu

[[File:Qstlink2startmenuwindows.png]]

Once you start it, you have to click on ''Connect'', and it should find your ''stm32f4discovery'' board. After that, click on ''Send'' and select the ''main.bin'' file in the Miosix top-level directory.

[[File:Qstlink2flashingwindows.png]]

Note that, regardless of using QSTLink2 form the DOS prompt or the GUI, there is a bug that in some circumstances blocks the microcontroller until the next powercycle. Therefore, after having programmed the microcontroller, it is recomended to unplug and reconnect the USB cable to powercycle the ''stm32f4discovery'' board. At that point, you shuold see the red LED blinking.

Lastly, if you have a brand new board and QSTlink doesn't work you may take a look at [[ST-LINK utility update|this page]].

=== What's next? ===

You have finished the installation of the Miosix Toolchain. You may want to [[Quick start#IDE Configuration|install and configure an IDE]], or the [[Quick start#In-circuit debugger|debugger]].

=== Uninstall the Miosix Toolchain ===

To uninstall the Miosix Toolchain, you can find the uninstaller in the start menu under ''Miosix Toolchain''. Note that Git, Perl and the STLink drivers have their own uninstallers. Also, the ''miosix-kernel'' in the ''Documents'' directory will not be removed.

[[Category:Installation and Configuration]]

Linux Quick Start

2016-12-16T08:48:04Z

Silseva:

This page explains how to install the precompiled Miosix Toolchain. If you prefer compiling GCC from sources, see [[Building GCC from sources]].

=== Before you begin ===

'''64 bit Linux distros'''

The precompiled Miosix Toolchain is compiled for 32bit x86, to be compatible with as many Linux installations as possible. If you have a 64bit OS, you need to install a few 32bit libraries to be able to use it.

<source lang="bash">
sudo apt-get install libstdc++6:i386 # Install 32bit compatibility libraries for Ubuntu/Debian
sudo pacman -S lib32-libstdc++5 # Install 32bit compatibility libraries for Arch Linux
</source>

''' QSTLink2 '''

If you want to program STM32 microcontrollers, you will also need a tool to the transfer your programs to the microcontroller. A popular choice for boards like the ''stm32f4discovery'' that have an embedded STLinkV2 USB programmer/debugger is [https://code.google.com/p/qstlink2 QSTLink2]. The installation on Ubuntu/Debian requires to add a ''ppa'' and install it via ''apt-get''. Also, it is recomended to install the udev rules, which allow QSTLink2 to connect to the USB port without the need to run it from root.

<source lang="bash">
sudo add-apt-repository ppa:fpoussin/ppa
sudo apt-get update
sudo apt-get install qstlink2
wget https://raw.githubusercontent.com/mobyfab/QStlink2/master/res/49-stlinkv2.rules
sudo mv 49-stlinkv2.rules /etc/udev/rules.d
sudo chown root:root /etc/udev/rules.d/49-stlinkv2.rules
</source>

An alternative tool to program STM32 microcontrollers using the serial port bootloader is [https://code.google.com/p/stm32flash stm32flash]. Finally, for historical reasons, the Miosix Toolchain includes ''lpc21isp'', a tool to program LPC2000 microcontrollers using their serial bootloader.

''' Serial port setup '''

Miosix redirects ''stdin''/''stdout'' to a serial port by default on most boards, so it is important to set up serial ports correctly on your development machine. On most Linux distros serial ports, both the physical ones like ''/dev/ttyS0'' and the USB to serial adapters like ''/dev/ttyUSB0'' are owned by the ''dialout'' group, so you need to add your user to that group before you can access them.

<source lang="bash">
sudo usermod -a -G dialout `id -un` # Add yourself to the dialout group
</source>

Note that you may need to reboot your computer before the change takes effect. Also, you need a program to interact with the serial port, like ''GNU screen''.

<source lang="bash">
sudo apt-get install screen # For Ubuntu/Debian
sudo pacman -S screen # For Arch Linux
</source>

=== Install the Miosix Toolchain ===

Download the latest version of the [[Miosix Toolchain]] and launch it. The installer will ask for your root password to copy the compiler to the ''/opt/arm-miosix-eabi'' directory, and put symlinks to ''/usr/bin''.

<source lang="bash">
wget https://miosix.org/toolchain/MiosixToolchainInstaller.run
sh MiosixToolchainInstaller.run
</source>

If you do not trust the installer and want to verify its content, or you want to install it locally, it is possible to extract the content of the installer with the following command.

<source lang="bash">
sh MiosixToolchainInstaller.run --noexec --target arm-miosix-eabi
</source>

Keep in mind that for a local install you will need to set the ''PATH'' environment variable to the ''arm-miosix-eabi/bin'' directory.

=== Get the Miosix kernel sources ===

The preferred way to download the Miosix kernel is through [https://en.wikipedia.org/wiki/Git_%28software%29 git]. If you do not already have it installed you can install it now

<source lang="bash">
sudo apt-get install git # For Ubuntu/Debian
sudo pacman -S git # For Arch Linux
</source>

The Miosix git repository used to be hosted at [http://gitorious.org gitorious.org], but the service was shut down. For this reason, the kernel is now hosted directly at miosix.org. There is also a [https://github.com/fedetft/miosix-kernel github mirror] and the two repositories will be always kept in sync. Currently, the ''master'' branch contains the stable 2.0 kernel, while the ''testing'' branch contains the current development version. Kernel versions prior to 2.0 are deprecated.

<source lang="bash">
git clone https://miosix.org/git-public/miosix-kernel.git
cd miosix-kernel
git fetch origin
## To select the development version of the kernel
#git checkout -b testing origin/testing
</source>

=== Configuring and compiling the kernel ===

More in-depth information on how th configure the kernel for your board can be found in the [[Board list]], but for now we will assume you have an stm32f4discovery, which is a common board, and briefly show how to get to a blinking LED example.

'''Top-level directory'''

First of all the miosix-kernel directory is often referred to as the '''top-level directory''' of the kernel. It contains, among other, the ''main.cpp'' file which is where you can start writing your application code, the ''Makefile'' where you can add additional C++ and C source files to be compiled, and the ''miosix'' directory which contains the kernel.

[[File:Miosixtopleveldirectorylinux.png]]

All paths in this wiki, unless they start with a '/' (for Linux) or 'C:\' (For Windows), are intended relative to Miosix's top-level directory, so if we're talking about the 'miosix/config/Makefile.inc' file you can find it within the directory where you have downloaded the kernel from git.

'''Configuring the kernel'''

The kernel is configured by editing two files, named [[Makefile.inc|miosix/config/Makefile.inc]] and [[miosix_settings.h|miosix/config/miosix_settings.h]]. Open the first one, and select your board. To do so, look for the ''OPT_BOARD'' section of the file, which looks like this:

<source lang="bash">
##
## Target board, choose one. This also implicitly select the target
## architecture
##
#OPT_BOARD := lpc2138_miosix_board
OPT_BOARD := stm32f103ze_stm3210e-eval
#OPT_BOARD := stm32f103ve_mp3v2
#OPT_BOARD := stm32f100rb_stm32vldiscovery
#OPT_BOARD := stm32f103ve_strive_mini
#OPT_BOARD := stm32f103ze_redbull_v2
#OPT_BOARD := stm32f407vg_stm32f4discovery
#OPT_BOARD := stm32f207ig_stm3220g-eval
#OPT_BOARD := stm32f207zg_ethboard_v2
#OPT_BOARD := stm32f207ze_als_camboard
#OPT_BOARD := stm32l151_als_mainboard
#OPT_BOARD := stm32f407vg_bitsboard
#OPT_BOARD := stm32f205rg_sony-newman
</source>
In Makefile syntax a '#' sign denotes a comment, so to select a board you have to comment out (by prepending a '#') the default board selected, and uncomment (by removing the '#' at the start of the line) your board, in this case, which in this example will assume is the ''stm32f407vg_stm32f4discovery''.

Next, edit the ''miosix_settings.h'' file and uncomment (by removing the '//' at the start of the line) the following line
<source lang="CPP">
//#define JTAG_DISABLE_SLEEP
</source>
(which is towards the end of the file). This is a C++ header file, so the comment syntax is '//'. More information on the meaning of this line can be found in [[miosix_settings.h]], but a short summary is that this line prevents the kernel from putting shutting down the CPU when it has nothing to do, which saves power but interferes with the programming/debugging protocol used to program the board via QSTLink2.

Also, comment out the ''#error'' line towards the beginning of the file. This line exists to cause a compilation error if the user forgets to edit the ''miosix_settings.h'' file. The result should look like this:
<source lang="CPP">
// Before you can compile the kernel you have to configure it by editing this
// file. After that, comment out this line to disable the reminder error.
// The PARSING_FROM_IDE is because Netbeans gets confused by this, it is never
// defined when compiling the code.
#ifndef PARSING_FROM_IDE
//#error This error is a reminder that you have not edited miosix_settings.h yet.
#endif //PARSING_FROM_IDE
</source>

'''Blink a LED'''

Open the ''main.cpp'' file in the top-level directory, and replace its content with the following program:
<source lang="CPP">
#include <miosix.h>
using namespace miosix;
int main()
{
for(;;)
{
ledOn();
Thread::sleep(1000);
ledOff();
Thread::sleep(1000);
}
}
</source>
The Miosix board support package defines the ''ledOn()'' and ''ledOff()'' functions to control a LED on the board for all the boards that have at least one software-accessible LED.

'''Compiling'''

To compile the kernel, open a terminal in the Miosix top-level directory and type ''make''. If all goes well, the result should look like this.

[[File:Makeoutputlinux.png]]

Otherwise, compiler errors will appear in the shell. The number that appears under ''text'' in the make output is the size in bytes of your application plus the kernel. If you think that 90KBytes is a bit too much for a blinking led, don't worry. The kernel by default includes support for C stdio functions, filesystem code including Unicode support and the C++ exception handling runtime, all of which can be disabled to significantly [[Miosix code size optimization|reduce code size]].

'''Programming'''

There are two ways to program the stm32f4discovery board. One is to use QSTLink2 directly from the shell you already have open by typing 'make program' (connect the USB cable first!), the other is through QSTLink2's GUI.

[[File:Findqstlink2guilinux.png]]

Once you start it, you have to click on ''Connect'', and it should find your ''stm32f4discovery'' board. After that, click on ''Send'' and select the ''main.bin'' file in the Miosix top-level directory.

[[File:Qstlink2flashinglinux.png]]

Note that, regardless of using QSTLink2 form the shell or the GUI, there is a bug that in some circumstances blocks the microcontroller until the next powercycle. Therefore, after having programmed the microcontroller, is is recomended to unplug and reconnect the USB cable to powercycle the ''stm32f4discovery'' board. At that point, you shuold see the red LED blinking.

Lastly, if you have a brand new board and QSTlink doesn't work you may take a look at [[ST-LINK utility update|this page]].

=== What's next? ===

You have finished the installation of the Miosix Toolchain. You may want to [[Quick start#IDE Configuration|install and configure an IDE]], or the [[Quick start#In-circuit debugger|debugger]].

=== Uninstall the compiler ===

If for some reason you need to uninstall the compiler, there is an uninstall script in the ''/opt/arm-miosix-eabi'' directory (Note: if you have built the compiler from sources the uninstall script may not be there). Running the script will uninstall the compiler and the symbolic links in the ''/usr/bin'' directory. Just like the install script, the uninstaller will ask for your root password to be able to remove the installed files.

There is no need to uninstall and old compiler to install a new one, the installer will take care of that automatically. However, if you have installed the compiler and now you want to build it from sources, you first need to uninstall the old compiler.

<source lang="bash">
cd /opt/arm-miosix-eabi
./uninstall.sh
</source>

If you have chosen to install the compiler locally (i.e: not in the '/opt/arm-miosix-eabi' directory), simply remove the compiler directory.

[[Category:Installation and Configuration]]

Stm32f407vg stm32f4discovery

2016-12-16T08:43:08Z

Silseva:

This is a cheap self contained [http://www.st.com/web/catalog/tools/PF252419 discovery board] with a powerful processor, and a Linux-friendly [http://www.st.com/web/catalog/tools/PF219866 ST-LINK/V2] programmer/in circuit debugger.
The board is equipped with
* A [http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN11/PF252140 STM32F407VG] microcontroller with a 168MHz ARM Cortex-M4F core, 1024KB Flash, 192KB RAM, 4KB battery-backed RAM in LQFP100 package.
* A LIS302DL accelerometer, MP45DT02 mems microphone, CS43L22 audio DAC, 4 user LEDs, user button, reset button, a second USB connector as the microcontroller supports USB.

[[File:Stm32f4discovery.jpg|frameless]]

== Configuring the kernel ==

The minimum configuration required is to edit the [[Makefile.inc|miosix/config/Makefile.inc]] file to uncomment the ''OPT_BOARD := stm32f407vg_stm32f4discovery'' line. If you had compiled the kernel before, it is recommended to do a ''make clean'' (or in the Netbeans IDE, to click on the "Clean project" button) to avoid leaving object files around. After, do a ''make'' to compile.

In addition, this board has a couple of board-specific options in the Makefile.inc file. For convenience, the relevant part of that configuration file is reported here so as to be easily located within the file

<source lang="CPP">
##---------------------------------------------------------------------------
## stm32f407vg_stm32f4discovery
##
ifeq ($(OPT_BOARD),stm32f407vg_stm32f4discovery)

## Linker script type, there are two options
## 1) Code in FLASH, stack + heap in internal RAM (file *_rom.ld)
## 2) Code + stack + heap in internal RAM (file *_ram.ld)
LINKER_SCRIPT_PATH := arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/
LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_1m+192k_rom.ld
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_1m+192k_ram.ld

## This causes the interrupt vector table to be relocated in SRAM, must be
## uncommented when using the ram linker script
#SRAM_BOOT := -DVECT_TAB_SRAM

endif
</source>

As can be seen, there are two options for this board: LINKER_SCRIPT and SRAM_BOOT. The comments explain in detail the meaning of there options, so it isn't necessary to further explain them.

After modifying configuration files it is recommended to do a make clean; make (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

== Loading code ==

As explained before, there are more than one linker script for this board, and the selected linker script affects the way code should be loaded on the board.

===stm32_1m+192k_rom.ld===
This is the default linker script, and puts the code in FLASH, so you need to program the microcontroller's FLASH every time you change your code, but code will run faster and won't be lost at each reboot.

A simple way to load code in FLASH is to use the [https://github.com/fpoussin/QStlink2 QStlink2] tool. Also, if you have a brand new board and QStlink fails you may take a look at [[ST-LINK utility update|this page]]

===stm32_1m+192k_ram.ld===
This linker script is very useful for debugging code on this board, as it locates everything (code, stack, heap) in the microcontroller's RAM. It has the disadvantage that the loaded code is lost upon reboot (being in a volatile memory), but for debugging, it is not an issue.

== Reading printf output ==

The board has no serial to USB adapter onboard, so you need to use an external one, connected to USART3, in detail PB10 (TXD) and PB11 (RXD). The choice of USART3 was done due to the fact that USART1 pins are not free on this board.

On Linux you can use screen. Open a terminal and type ''screen /dev/ttyUSB0 115200'' (Note that to quit from screen you need to type "Ctrl-C, \"). You'll need to change /dev/ttyUSB0 with your serial port device name.

On windows you can use HyperTerminal, you need to configure it to use the required baud rate, no flow control, and select the correct COM port device name.

== In Circuit Debugging ==

Before you begin you should note that the Miosix kernel will put the CPU to a low power state when no thread is running. This low power state will usually confuse debuggers and make them lose sync with the CPU. To avoid this you need to edit the [[miosix_settings.h|miosix/config/miosix_settings.h]] file and uncomment ''#define JTAG_DISABLE_SLEEP'' line. This will prevent the kernel from putting the CPU in its low power state making debugging possible.
Also, to be able to precisely single-step your code you need to disable compiler optimizations as gdb is incapable of reliably debug an optimized code. The option is in the miosix/config/Makefile.inc file and is the ''OPT_OPTIMIZATION := -O0'' that should be uncommented while the other lines related to the same option should be commented out.

After modifying configuration files it is recommended to do a ''make clean; make'' (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

Since the board has an on board SWD in circuit debugger, simply plugging the USB cable is all you need from an hardware point of view.
On the software side, you need to open two shells. In one do a

<source lang="BASH">
sudo openocd -f miosix/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/stm32f4discovery.cfg
</source>

This will start the OpenOCD program that will connect to the board and listen for GDB connections.

In the second shell type the following commands

<source lang="BASH">
arm-miosix-eabi-gdb main.elf
target remote :3333
monitor soft_reset_halt
break main
continue
</source>

The first command will start the gdb debugger. The following commands are typed into the gdb console, and tell it to connect to OpenOCD, and reset the board and stop the program at the beginning of main()
To load the program to be debugged, you can either do a make program before and then start debugging, or you can directly write the FLASH memory from within gdb with this command

<source lang="BASH">
monitor flash write_image erase main.bin 0x08000000
</source>

From there on, have a look at [[Quick_start]] for debugger commands.

== (Optional) Configuring the Netbeans IDE ==
To have a fully working code completion that can also resolve the board-specific symbols, right click on the project, go to Set Configuration and select the right board.

[[File: Netbeans-config.png]]

== SD Card ==

This board lacks an SD connector, so the filesystem support does not work out of the box (upon boot the kernel will say that filesystem mounting failed). However, it is possible to connect one to specific GPIO pins.

The SD or microSD connector VCC and GND pins need to be connected to 3V and GND pins on the board. Add a 100nF capacitor between VCC and GND, as close as possible to the SD connector. This will be useful to overcome current absorption peaks from the SD card.

Then connect the following GPIOs to the SD connector.

{| class="wikitable"
|-
! SD !! STM32 !! Optional
|-
| CLK || PC12 ||
|-
| CMD || PD2 ||
|-
| D0 || PC8 ||
|-
| D1 || PC9 || Y
|-
| D2 || PC10 || Y
|-
| D3 || PC11 || Y
|}

Each connection needs a pullup resistor between ~47Kohm and 100Kohm.

To increase read/write speed it is possible to connect the optional GPIOs thereby communicating with the SD in 4-bit mode.
Note that by default in this board the SD driver uses 1 bit mode. To enable 4-bit mode you need to edit the ''miosix/config/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/board_settings.h'' and comment out the ''#define SD_ONE_BIT_DATABUS'' line.

Also note that filesystem support is enabled by default, so the pins marked as not optional are used by the filesystem driver. If you do not want to connect an SD card, and want to use those GPIOs, you should disable the filesystem support in [[miosix_settings.h|miosix/config/miosix_settings.h]].

== Resource ==
stm32f4discovery [http://www.st.com/st-web-ui/static/active/en/resource/technical/document/user_manual/DM00039084.pdf Datasheet]

[[Category:Boards]]

Stm32f429zi stm32f4discovery

2016-12-16T08:42:20Z

Silseva: updated code uploading guide

This is a cheap self contained [http://www2.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f429idiscovery.html discovery board] with a powerful processor, and a Linux-friendly [http://www.st.com/web/catalog/tools/PF219866 ST-LINK/V2] programmer/in circuit debugger.
The board is equipped with
* A [http://www2.st.com/content/st_com/en/products/microcontrollers/stm32-32-bit-arm-cortex-mcus/stm32f4-series/stm32f429-439/stm32f429zi.html STM32F429ZI] microcontroller with a 180MHz ARM Cortex-M4F core, 2048KB Flash, 256KB RAM, 4KB battery-backed RAM in LQFP144 package.
* An external 64Mb SRAM, L3GD20 3-axis digital output gyroscope, 2.4" QVGA TFT LCD, 2 user LEDs, user button, reset button, a second USB connector as the microcontroller supports USB.

[[File:Stm32f429disco.jpg|frameless]]

== Configuring the kernel ==

The minimum configuration required is to edit the [[Makefile.inc|miosix/config/Makefile.inc]] file to uncomment the ''OPT_BOARD := stm32f429zi_stm32f4discovery'' line. If you had compiled the kernel before, it is recommended to do a ''make clean'' (or in the Netbeans IDE, to click on the "Clean project" button) to avoid leaving object files around. After, do a ''make'' to compile.

In addition, this board has a couple of board-specific options in the Makefile.inc file. For convenience, the relevant part of that configuration file is reported here so as to be easily located within the file

<source lang="CPP">
##---------------------------------------------------------------------------
## stm32f429zi_stm32f4discovery
##
ifeq ($(OPT_BOARD),stm32f429zi_stm32f4discovery)

## Linker script type, there are three options
## 1) Code in FLASH, stack + heap in internal RAM (file *_rom.ld)
## the most common choice, available for all microcontrollers
## 2) Code in FLASH, stack + heap in external RAM (file *8m_xram.ld)
## You must uncomment -D__ENABLE_XRAM below in this case.
## 3) Code in FLASH, stack + heap in external RAM (file *6m_xram.ld)
## Same as above, but leaves the upper 2MB of RAM for the LCD.
LINKER_SCRIPT_PATH := arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+256k_rom.ld
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+8m_xram.ld
LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+6m_xram.ld

## Uncommenting __ENABLE_XRAM enables the initialization of the external
## 8MB SDRAM memory. Do not uncomment this even if you don't use a linker
## script that requires it, as it is used for the LCD framebuffer.
XRAM := -D__ENABLE_XRAM

## Select clock frequency. Warning: the default clock frequency for
## this board is 168MHz and not 180MHz because, due to a limitation in
## the PLL, it is not possible to generate a precise 48MHz output when
## running the core at 180MHz. If 180MHz is chosen the USB peripheral will
## NOT WORK and the SDIO and RNG will run ~6% slower (45MHz insteand of 48)
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_180MHz=180000000
CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_168MHz=168000000
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_100MHz=100000000

endif
</source>

As can be seen, there are two options for this board: LINKER_SCRIPT and SRAM_BOOT. The comments explain in detail the meaning of there options, so it isn't necessary to further explain them.

After modifying configuration files it is recommended to do a make clean; make (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

== Loading code ==

As explained before, there are more than one linker script for this board, and the selected linker script affects the way code should be loaded on the board.

A simple way to load code in FLASH is to use the [https://github.com/fpoussin/QStlink2 QStlink2] tool. Also, if you have a brand new board and QStlink fails you may take a look at [[ST-LINK utility update|this page]]

== Reading printf output ==

The board has no serial to USB adapter onboard, so you need to use an external one, connected to USART3, in detail PA9 (TXD) and PA10 (RXD).

On Linux you can use screen. Open a terminal and type ''screen /dev/ttyUSB0 19200'' (Note that to quit from screen you need to type "Ctrl-C, \"). You'll need to change /dev/ttyUSB0 with your serial port device name.

On windows you can use HyperTerminal, you need to configure it to use the required baud rate, no flow control, and select the correct COM port device name.

== In Circuit Debugging ==

Before you begin you should note that the Miosix kernel will put the CPU to a low power state when no thread is running. This low power state will usually confuse debuggers and make them lose sync with the CPU. To avoid this you need to edit the [[miosix_settings.h|miosix/config/miosix_settings.h]] file and uncomment ''#define JTAG_DISABLE_SLEEP'' line. This will prevent the kernel from putting the CPU in its low power state making debugging possible.
Also, to be able to precisely single-step your code you need to disable compiler optimizations as gdb is incapable of reliably debug an optimized code. The option is in the miosix/config/Makefile.inc file and is the ''OPT_OPTIMIZATION := -O0'' that should be uncommented while the other lines related to the same option should be commented out.

After modifying configuration files it is recommended to do a ''make clean; make'' (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

Since the board has an on board SWD in circuit debugger, simply plugging the USB cable is all you need from an hardware point of view.
On the software side, you need to open two shells. In one do a

<source lang="BASH">
sudo openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg
</source>

This will start the OpenOCD program that will connect to the board and listen for GDB connections.

In the second shell type the following commands

<source lang="BASH">
arm-miosix-eabi-gdb main.elf
target remote :3333
monitor soft_reset_halt
break main
continue
</source>

The first command will start the gdb debugger. The following commands are typed into the gdb console, and tell it to connect to OpenOCD, and reset the board and stop the program at the beginning of main()
To load the program to be debugged, you can either do a make program before and then start debugging, or you can directly write the FLASH memory from within gdb with this command

<source lang="BASH">
monitor flash write_image erase main.bin 0x08000000
</source>

From there on, have a look at [[Quick_start]] for debugger commands.

== (Optional) Configuring the Netbeans IDE ==
To have a fully working code completion that can also resolve the board-specific symbols, right click on the project, go to Set Configuration and select the right board.

[[File: Netbeans-config.png]]

== SD Card (FIXME!!!!) ==

This board lacks an SD connector, so the filesystem support does not work out of the box (upon boot the kernel will say that filesystem mounting failed). However, it is possible to connect one to specific GPIO pins.

The SD or microSD connector VCC and GND pins need to be connected to 3V and GND pins on the board. Add a 100nF capacitor between VCC and GND, as close as possible to the SD connector. This will be useful to overcome current absorption peaks from the SD card.

Then connect the following GPIOs to the SD connector.

{| class="wikitable"
|-
! SD !! STM32 !! Optional
|-
| CLK || PC12 ||
|-
| CMD || PD2 ||
|-
| D0 || PC8 ||
|-
| D1 || PC9 || Y
|-
| D2 || PC10 || Y
|-
| D3 || PC11 || Y
|}

Each connection needs a pullup resistor between ~47Kohm and 100Kohm.

To increase read/write speed it is possible to connect the optional GPIOs thereby communicating with the SD in 4-bit mode.
Note that by default in this board the SD driver uses 1 bit mode. To enable 4-bit mode you need to edit the ''miosix/config/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/board_settings.h'' and comment out the ''#define SD_ONE_BIT_DATABUS'' line.

Also note that filesystem support is enabled by default, so the pins marked as not optional are used by the filesystem driver. If you do not want to connect an SD card, and want to use those GPIOs, you should disable the filesystem support in [[miosix_settings.h|miosix/config/miosix_settings.h]].

== Resource ==
stm32f4discovery [http://www2.st.com/content/ccc/resource/technical/document/user_manual/6b/25/05/23/a9/45/4d/6a/DM00093903.pdf/files/DM00093903.pdf/jcr:content/translations/en.DM00093903.pdf Datasheet]

[[Category:Boards]]

Stm32f407vg stm32f4discovery

2016-12-16T08:39:58Z

Silseva: qstlink update

This is a cheap self contained [http://www.st.com/web/catalog/tools/PF252419 discovery board] with a powerful processor, and a Linux-friendly [http://www.st.com/web/catalog/tools/PF219866 ST-LINK/V2] programmer/in circuit debugger.
The board is equipped with
* A [http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN11/PF252140 STM32F407VG] microcontroller with a 168MHz ARM Cortex-M4F core, 1024KB Flash, 192KB RAM, 4KB battery-backed RAM in LQFP100 package.
* A LIS302DL accelerometer, MP45DT02 mems microphone, CS43L22 audio DAC, 4 user LEDs, user button, reset button, a second USB connector as the microcontroller supports USB.

[[File:Stm32f4discovery.jpg|frameless]]

== Configuring the kernel ==

The minimum configuration required is to edit the [[Makefile.inc|miosix/config/Makefile.inc]] file to uncomment the ''OPT_BOARD := stm32f407vg_stm32f4discovery'' line. If you had compiled the kernel before, it is recommended to do a ''make clean'' (or in the Netbeans IDE, to click on the "Clean project" button) to avoid leaving object files around. After, do a ''make'' to compile.

In addition, this board has a couple of board-specific options in the Makefile.inc file. For convenience, the relevant part of that configuration file is reported here so as to be easily located within the file

<source lang="CPP">
##---------------------------------------------------------------------------
## stm32f407vg_stm32f4discovery
##
ifeq ($(OPT_BOARD),stm32f407vg_stm32f4discovery)

## Linker script type, there are two options
## 1) Code in FLASH, stack + heap in internal RAM (file *_rom.ld)
## 2) Code + stack + heap in internal RAM (file *_ram.ld)
LINKER_SCRIPT_PATH := arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/
LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_1m+192k_rom.ld
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_1m+192k_ram.ld

## This causes the interrupt vector table to be relocated in SRAM, must be
## uncommented when using the ram linker script
#SRAM_BOOT := -DVECT_TAB_SRAM

endif
</source>

As can be seen, there are two options for this board: LINKER_SCRIPT and SRAM_BOOT. The comments explain in detail the meaning of there options, so it isn't necessary to further explain them.

After modifying configuration files it is recommended to do a make clean; make (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

== Loading code ==

As explained before, there are more than one linker script for this board, and the selected linker script affects the way code should be loaded on the board.

===stm32_1m+192k_rom.ld===
This is the default linker script, and puts the code in FLASH, so you need to program the microcontroller's FLASH every time you change your code, but code will run faster and won't be lost at each reboot.

A simple way to load code in FLASH is to use the [https://github.com/fpoussin/QStlink2 QStlink2] tool. If you have a brand new board and QStlink fails you may take a look at [[ST-LINK utility update|this page]]

===stm32_1m+192k_ram.ld===
This linker script is very useful for debugging code on this board, as it locates everything (code, stack, heap) in the microcontroller's RAM. It has the disadvantage that the loaded code is lost upon reboot (being in a volatile memory), but for debugging, it is not an issue.

== Reading printf output ==

The board has no serial to USB adapter onboard, so you need to use an external one, connected to USART3, in detail PB10 (TXD) and PB11 (RXD). The choice of USART3 was done due to the fact that USART1 pins are not free on this board.

On Linux you can use screen. Open a terminal and type ''screen /dev/ttyUSB0 115200'' (Note that to quit from screen you need to type "Ctrl-C, \"). You'll need to change /dev/ttyUSB0 with your serial port device name.

On windows you can use HyperTerminal, you need to configure it to use the required baud rate, no flow control, and select the correct COM port device name.

== In Circuit Debugging ==

Before you begin you should note that the Miosix kernel will put the CPU to a low power state when no thread is running. This low power state will usually confuse debuggers and make them lose sync with the CPU. To avoid this you need to edit the [[miosix_settings.h|miosix/config/miosix_settings.h]] file and uncomment ''#define JTAG_DISABLE_SLEEP'' line. This will prevent the kernel from putting the CPU in its low power state making debugging possible.
Also, to be able to precisely single-step your code you need to disable compiler optimizations as gdb is incapable of reliably debug an optimized code. The option is in the miosix/config/Makefile.inc file and is the ''OPT_OPTIMIZATION := -O0'' that should be uncommented while the other lines related to the same option should be commented out.

After modifying configuration files it is recommended to do a ''make clean; make'' (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

Since the board has an on board SWD in circuit debugger, simply plugging the USB cable is all you need from an hardware point of view.
On the software side, you need to open two shells. In one do a

<source lang="BASH">
sudo openocd -f miosix/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/stm32f4discovery.cfg
</source>

This will start the OpenOCD program that will connect to the board and listen for GDB connections.

In the second shell type the following commands

<source lang="BASH">
arm-miosix-eabi-gdb main.elf
target remote :3333
monitor soft_reset_halt
break main
continue
</source>

The first command will start the gdb debugger. The following commands are typed into the gdb console, and tell it to connect to OpenOCD, and reset the board and stop the program at the beginning of main()
To load the program to be debugged, you can either do a make program before and then start debugging, or you can directly write the FLASH memory from within gdb with this command

<source lang="BASH">
monitor flash write_image erase main.bin 0x08000000
</source>

From there on, have a look at [[Quick_start]] for debugger commands.

== (Optional) Configuring the Netbeans IDE ==
To have a fully working code completion that can also resolve the board-specific symbols, right click on the project, go to Set Configuration and select the right board.

[[File: Netbeans-config.png]]

== SD Card ==

This board lacks an SD connector, so the filesystem support does not work out of the box (upon boot the kernel will say that filesystem mounting failed). However, it is possible to connect one to specific GPIO pins.

The SD or microSD connector VCC and GND pins need to be connected to 3V and GND pins on the board. Add a 100nF capacitor between VCC and GND, as close as possible to the SD connector. This will be useful to overcome current absorption peaks from the SD card.

Then connect the following GPIOs to the SD connector.

{| class="wikitable"
|-
! SD !! STM32 !! Optional
|-
| CLK || PC12 ||
|-
| CMD || PD2 ||
|-
| D0 || PC8 ||
|-
| D1 || PC9 || Y
|-
| D2 || PC10 || Y
|-
| D3 || PC11 || Y
|}

Each connection needs a pullup resistor between ~47Kohm and 100Kohm.

To increase read/write speed it is possible to connect the optional GPIOs thereby communicating with the SD in 4-bit mode.
Note that by default in this board the SD driver uses 1 bit mode. To enable 4-bit mode you need to edit the ''miosix/config/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/board_settings.h'' and comment out the ''#define SD_ONE_BIT_DATABUS'' line.

Also note that filesystem support is enabled by default, so the pins marked as not optional are used by the filesystem driver. If you do not want to connect an SD card, and want to use those GPIOs, you should disable the filesystem support in [[miosix_settings.h|miosix/config/miosix_settings.h]].

== Resource ==
stm32f4discovery [http://www.st.com/st-web-ui/static/active/en/resource/technical/document/user_manual/DM00039084.pdf Datasheet]

[[Category:Boards]]

ST-LINK utility update

2016-12-16T08:36:48Z

Silseva: added page

Recently ST Microelectronics has updated the firmware used for the ST-LINK utility that is present on all the STM32 Discovery boards. Unfortunately this update in not compatible with the QStlink GUI tool recommended in this wiki to upload your firmware into the Discovery board's microcontroller.

The boards with the new firmware are identified by one of these facts:
* the board order code has the word "DISC1" at its end, as an example: "STM32F429I-DISC1"
* the ST-LINK firmware version is "ST-LINK/V2-B"
* when the board is connected to a computer is seen by the operating system as an USB key.

Luckily a new procedure to flash the board using QStlink has been found, even if at this moment it has been tested only under Linux (if someone manages to flash a board with this procedure under other operating systems, please report it to us and we will update this page).

===== New flashing procedure =====

* Connect the board to the PC
* Ignore the fact that it's recognised as an USB key, but don't unmount it
* Open the terminal
* Move to the folder that contains the .bin file you wish to upload
* Type '''''sudo qstlink2 -cwV [filename].bin''''', where [filename] is the name of the new firmware's file
* If the board doesn't execute the firmware you have just uploaded press the ''reset'' button or try resetting the power unplugging and reconnecting the USB cable

Main Page

2016-12-16T08:10:52Z

Silseva:

Welcome to the Miosix wiki. This wiki contains the documentation for the Miosix kernel.


= Getting started =
Follow the [[Quick start]] to install the Miosix Toolchain and compile the Miosix 2.0 kernel.

= Software =
* Have a look at the Miosix [[API list|APIs]] and [[Library list|libraries]] that you can use for your applications.
* The page on [[Synchronization primitives]] lists the possible ways to shnchronize beween multiple threads or between a thread and an interrupt routine.
* How to [[Miosix code size optimization|reduce the kernel code size]] for deeply embedded applications.

= Hardware =
Check out which microcontroller [[Board list|boards]] are supported by Miosix.

= Account creation =
Due to spam (within two days from setting up the wiki) account registration is disabled. If you want to create an account, ask to fede.tft&&miosix.org (s/&&/@/)

= Index =
* [[Special:Categories|Categories]]
* [[Special:AllPages|All Pages]]

Main Page

2016-12-16T08:04:31Z

Silseva: added Qstlink caveat

Welcome to the Miosix wiki. This wiki contains the documentation for the Miosix kernel.

<br><div style="background-color:#FFA0A0;">
IMPORTANT NOTICE: <br>
Recently ST Microeletronics has changed the firmware used for ST-LINK utility on its Discovery boards. For this reason, if you have bought a STM32 Discovery board recently, it's highly possible that you may encounter problems in uploading your firmware using the Qstlink GUI utility. <br>
Until an update of the Qstlink utility is released (which not depends upon us), in [[Qstlink workaround|this page]] you can find a temporary fix for this issue.
</div><br>

= Getting started =
Follow the [[Quick start]] to install the Miosix Toolchain and compile the Miosix 2.0 kernel.

= Software =
* Have a look at the Miosix [[API list|APIs]] and [[Library list|libraries]] that you can use for your applications.
* The page on [[Synchronization primitives]] lists the possible ways to shnchronize beween multiple threads or between a thread and an interrupt routine.
* How to [[Miosix code size optimization|reduce the kernel code size]] for deeply embedded applications.

= Hardware =
Check out which microcontroller [[Board list|boards]] are supported by Miosix.

= Account creation =
Due to spam (within two days from setting up the wiki) account registration is disabled. If you want to create an account, ask to fede.tft&&miosix.org (s/&&/@/)

= Index =
* [[Special:Categories|Categories]]
* [[Special:AllPages|All Pages]]

MacOS Quick Start

2016-11-14T15:16:11Z

Silseva: /* Toolchain compilation and installation */

MacOS Quick Start

2016-11-14T15:07:01Z

Silseva: added testing branch

ATTENTION: This page is still a WIP. Usual disclaimers about not taking responsibility for your system disruption applies.

=== Before you begin ===

This procedure has been tested on OS X El Capitain 10.11. The Miosix toolchain has been successfully compiled using GCC 4.9.3, which can be installed using the Homebrew package manager.

'''Install Xcode'''

Install Xcode by downloading it from the Mac App Store [https://itunes.apple.com/au/app/xcode/id497799835?mt=12 here]. This is needed for installing the XCode command line tools which in turn is needed by Homebrew.

'''Install Xcode Command Line Tools'''

Install the Command Line Tools by running the following command in terminal:

<source lang="bash">
xcode-select --install
</source>

It is recommended to run the command even if Xcode and the Command Line Tools were already installed on your system, since the Command Line Tools installation may have been messed up by upgrading to 10.11 from a previous release.

'''Install Homebrew'''

Grab a copy of Homebrew and run the install script in one step using this command in terminal:

<source lang="bash">
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
</source>

If it complains about permission issues, then you have to fix it before you can continue. In Mac OS X El Capitan 10.11, Apple introduced a new feature called System Integrity Protector (SIP), which prevents from writing to many system directories such as /usr, /System, /bin, regardless of whether or not you are root. Apple is leaving /usr/local open for developers to use, so Homebrew can still be used as expected; however, performing a few steps may be required depending on you system, as outlined in the official Homebrew documentation [https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/El_Capitan_and_Homebrew.md here].

=== System dependencies installation ===

'''Install GNU tar'''

Running the Miosix toolchain compilation script may give you an error related to extracting a file. Therefore, using GNU tar instead of Apple tar is suggested.

Run this command in terminal to add the repository containing GNU tar to Homebrew:

<source lang="bash">
brew tap homebrew/dupes
</source>

Run this command in terminal to grab the most recent packages list from Homebrew:

<source lang="bash">
brew update
</source>

Run this command to install GNU tar:

<source lang="bash">
brew install gnu-tar
</source>

'''Install GCC 4.9.3'''

Running the Miosix toolchain compilation script using Apple GCC has proven unsuccessful. That's why we need to install GCC 4.9.3 from Homebrew. Perform the steps below:

Run this command in terminal to add the repository containing GCC 4.9.3 to Homebrew:

<source lang="bash">
brew tap homebrew/versions
</source>

Run this command in terminal to grab the most recent packages list from Homebrew:

<source lang="bash">
brew update
</source>

Run this command to install GCC 4.9.3:

<source lang="bash">
brew install gcc49
</source>

'''Symlink GCC 4.9.3 executables'''

First, you need to create appropriate symlinks within /usr/local/bin from the versioned name of gcc executables to generic ones. Run these commands from terminal:

<source lang="bash">
ln -s /usr/local/bin/gcc-4.9 /usr/local/bin/gcc
ln -s /usr/local/bin/gcc-4.9 /usr/local/bin/cc
ln -s /usr/local/bin/g++-4.9 /usr/local/bin/g++
ln -s /usr/local/bin/cpp-4.9 /usr/local/bin/cpp
ln -s /usr/local/bin/c++-4.9 /usr/local/bin/c++
</source>

Please notice that gcc-4.9 has not been symlinked to ld has someone may expect, since it has proven prone to errors during the Miosix toolchain compilation. Instead, we are gonna use Apple own Clang ld as a linker.

'''Edit $PATH variable'''

Now you need to make sure that /usr/local/bin gets inspected before /usr/bin when looking for gcc, so that Homebrew GCC 4.9.3 will be called instead of Apple GCC. In order to do so, we are gonna modify the $PATH terminal variable. Run from terminal:

<source lang="bash">
cd
</source>

To get into your home folder.

Run from terminal:

<source lang="bash">
edit .bash_profile
</source>

To edit the bash profile script.

You need to add the following lines as they are:

<source lang="bash">
#homebrew gcc
export PATH=/usr/local/bin:$PATH
#gnu-tar
export PATH=/usr/local/opt/gnu-tar/libexec/gnubin:$PATH
</source>

Save and close the file.

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

'''Check the installed packages'''

If everything went as supposed, running from terminal:

<source lang="bash">
gcc -v
</source>

should return some text including:

<source lang="bash">
gcc version 4.9.3 (Homebrew gcc49 4.9.3)
</source>

While running from terminal:

<source lang="bash">
ld -v
</source>

should return some text including:

<source lang="bash">
LTO support using: Apple LLVM 7.0.0
</source>

And finally running from terminal:

<source lang="bash">
tar --version
</source>

should return some text including:

<source lang="bash">
tar (GNU tar)
</source>

=== Toolchain compilation and installation ===

'''Toolchain sources download'''

In order to download the kernel and toolchains sources, you need git. If you don't have it already, you can install it using Homebrew:

<source lang="bash">
brew install git
</source>

From terminal, cd to a folder of your choice, making sure that the path from root to it doesn't contain spaces or special characters. Then run:

<source lang="bash">
git clone https://miosix.org/git-public/miosix-kernel.git
cd miosix-kernel
git fetch origin
## To select the development version of the kernel
#git checkout -b testing origin/testing
</source>

'''Toolchain dependencies download'''

You need to fix a link in the Miosix toolchain dependencies download script, located at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/download.sh
</source>

Replace the following line:

<source lang="bash">
wget http://www.mpfr.org/mpfr-current/mpfr-3.1.2.tar.xz
</source>

with:

<source lang="bash">
wget http://www.mpfr.org/mpfr-3.1.2/mpfr-3.1.2.tar.xz
</source>

Now you need to run the dependencies download script. From terminal, run:

<source lang="bash">
sh miosix-kernel/miosix/_tools/compiler/download.sh
</source>

from the folder where you performed the git clone command.

'''Toolchain compilation'''

System-wide installation of the toolchain is currently untested. It is then suggested to install it locally and then add its location the the $PATH.
First, edit the install script located at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/install-script.sh
</source>

such that at the end the first few lines looks as follow:

<source lang="bash">
# Uncomment if installing globally on the system
#INSTALL_DIR=/opt
#SUDO=sudo
# Uncomment if installing locally, sudo isn't necessary
INSTALL_DIR=`pwd`/gcc
SUDO=
</source>

We can now finally run the compilation script. From terminal, run:

<source lang="bash">
sh miosix-kernel/miosix/_tools/compiler/install-script.sh
</source>

At the end, if everything worked correctly, you'll find the toolchain at:

<source lang="bash">
miosix-kernel/miosix/_tools/compiler/gcc/arm-miosix-eabi/bin
</source>

'''Toolchain compilation and installation'''

Now you need to add the toolchain to your path. Edit the bash profile script and add the following lines:

<source lang="bash">
#arm-miosix-eabi
export PATH={my-folder-of-choice-path}/miosix-kernel/miosix/_tools/compiler/gcc/arm-miosix-eabi/bin:$PATH
</source>

where you have to replace {my-folder-of-choice-path} with the path of the folder where you run the git clone command.

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

'''Cleanup'''

You are now free to go back to Apple tar and GCC. In order to do so, edit the bash profile script and remove the following lines:

<source lang="bash">
#homebrew gcc
export PATH=/usr/local/bin:$PATH
#gnu-tar
export PATH=/usr/local/opt/gnu-tar/libexec/gnubin:$PATH
</source>

Then run from terminal:

<source lang="bash">
source .bash_profile
</source>

in order to reload the bash profile script.

=== Kernel compilation ===

In order to configure and compile the kernel, please follow the steps outlined in the [[Linux Quick Start|Linux Quick Start]].

=== Flash and debug an STM32F4DISCOVERY board ===

'''Tools installation'''

In order to be able to flash and debug an STM32F4DISCOVERY board, you need the stlink tools suite. You can grab it from Homebrew running:

<source lang="bash">
brew install stlink
</source>

API list

2016-04-15T17:38:40Z

Silseva: added interrupt tutorial link

Here is a list of some of the Miosix APIs, currently far form being complete

* The [[Serial port tutorial]] explains how to interface to a computer through the C functions ''printf()/scanf()'' or the C++ ''cin/cout'' objects.
* The [[Filesystem tutorial]] explains how to read/write to files on a SD or MicroSD card using the standard C/C++ API.
* The [[Pthread tutorial]] shows the basics of multithreading in Miosix using the standard [https://en.wikipedia.org/wiki/Pthread Pthread] API.
* The [[Native thread tutorial]] shows how to use the Miosix-specific thread API.
* The [[Event API]] allows to do thread pools using std::bind() and std::function().
* The [[GPIO tutorial]] shows how to interface with external hardware devices using the GPIO API.
* The [[HD44780 LCD tutorial]] shows how to connect a standard alphanumeric LCD to a board running Miosix.
* The [[Servo tutorial]] shows how to interface with servomotors from Miosix.
* The [[Interrupt tutorial]] shows how to handle interrupts generated from on-chip peripherals.

[[Category:API]]

Stm32f429zi stm32f4discovery

2016-04-07T12:45:04Z

Silseva: added board image

This is a cheap self contained [http://www2.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f429idiscovery.html discovery board] with a powerful processor, and a Linux-friendly [http://www.st.com/web/catalog/tools/PF219866 ST-LINK/V2] programmer/in circuit debugger.
The board is equipped with
* A [http://www2.st.com/content/st_com/en/products/microcontrollers/stm32-32-bit-arm-cortex-mcus/stm32f4-series/stm32f429-439/stm32f429zi.html STM32F429ZI] microcontroller with a 180MHz ARM Cortex-M4F core, 2048KB Flash, 256KB RAM, 4KB battery-backed RAM in LQFP144 package.
* An external 64Mb SRAM, L3GD20 3-axis digital output gyroscope, 2.4" QVGA TFT LCD, 2 user LEDs, user button, reset button, a second USB connector as the microcontroller supports USB.

[[File:Stm32f429disco.jpg|frameless]]

== Configuring the kernel ==

The minimum configuration required is to edit the [[Makefile.inc|miosix/config/Makefile.inc]] file to uncomment the ''OPT_BOARD := stm32f429zi_stm32f4discovery'' line. If you had compiled the kernel before, it is recommended to do a ''make clean'' (or in the Netbeans IDE, to click on the "Clean project" button) to avoid leaving object files around. After, do a ''make'' to compile.

In addition, this board has a couple of board-specific options in the Makefile.inc file. For convenience, the relevant part of that configuration file is reported here so as to be easily located within the file

<source lang="CPP">
##---------------------------------------------------------------------------
## stm32f429zi_stm32f4discovery
##
ifeq ($(OPT_BOARD),stm32f429zi_stm32f4discovery)

## Linker script type, there are three options
## 1) Code in FLASH, stack + heap in internal RAM (file *_rom.ld)
## the most common choice, available for all microcontrollers
## 2) Code in FLASH, stack + heap in external RAM (file *8m_xram.ld)
## You must uncomment -D__ENABLE_XRAM below in this case.
## 3) Code in FLASH, stack + heap in external RAM (file *6m_xram.ld)
## Same as above, but leaves the upper 2MB of RAM for the LCD.
LINKER_SCRIPT_PATH := arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+256k_rom.ld
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+8m_xram.ld
LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+6m_xram.ld

## Uncommenting __ENABLE_XRAM enables the initialization of the external
## 8MB SDRAM memory. Do not uncomment this even if you don't use a linker
## script that requires it, as it is used for the LCD framebuffer.
XRAM := -D__ENABLE_XRAM

## Select clock frequency. Warning: the default clock frequency for
## this board is 168MHz and not 180MHz because, due to a limitation in
## the PLL, it is not possible to generate a precise 48MHz output when
## running the core at 180MHz. If 180MHz is chosen the USB peripheral will
## NOT WORK and the SDIO and RNG will run ~6% slower (45MHz insteand of 48)
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_180MHz=180000000
CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_168MHz=168000000
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_100MHz=100000000

endif
</source>

As can be seen, there are two options for this board: LINKER_SCRIPT and SRAM_BOOT. The comments explain in detail the meaning of there options, so it isn't necessary to further explain them.

After modifying configuration files it is recommended to do a make clean; make (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

== Loading code ==

As explained before, there are more than one linker script for this board, and the selected linker script affects the way code should be loaded on the board.

== Reading printf output ==

The board has no serial to USB adapter onboard, so you need to use an external one, connected to USART3, in detail PA9 (TXD) and PA10 (RXD).

On Linux you can use screen. Open a terminal and type ''screen /dev/ttyUSB0 19200'' (Note that to quit from screen you need to type "Ctrl-C, \"). You'll need to change /dev/ttyUSB0 with your serial port device name.

On windows you can use HyperTerminal, you need to configure it to use the required baud rate, no flow control, and select the correct COM port device name.

== In Circuit Debugging ==

Before you begin you should note that the Miosix kernel will put the CPU to a low power state when no thread is running. This low power state will usually confuse debuggers and make them lose sync with the CPU. To avoid this you need to edit the [[miosix_settings.h|miosix/config/miosix_settings.h]] file and uncomment ''#define JTAG_DISABLE_SLEEP'' line. This will prevent the kernel from putting the CPU in its low power state making debugging possible.
Also, to be able to precisely single-step your code you need to disable compiler optimizations as gdb is incapable of reliably debug an optimized code. The option is in the miosix/config/Makefile.inc file and is the ''OPT_OPTIMIZATION := -O0'' that should be uncommented while the other lines related to the same option should be commented out.

After modifying configuration files it is recommended to do a ''make clean; make'' (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

Since the board has an on board SWD in circuit debugger, simply plugging the USB cable is all you need from an hardware point of view.
On the software side, you need to open two shells. In one do a

<source lang="BASH">
sudo openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg
</source>

This will start the OpenOCD program that will connect to the board and listen for GDB connections.

In the second shell type the following commands

<source lang="BASH">
arm-miosix-eabi-gdb main.elf
target remote :3333
monitor soft_reset_halt
break main
continue
</source>

The first command will start the gdb debugger. The following commands are typed into the gdb console, and tell it to connect to OpenOCD, and reset the board and stop the program at the beginning of main()
To load the program to be debugged, you can either do a make program before and then start debugging, or you can directly write the FLASH memory from within gdb with this command

<source lang="BASH">
monitor flash write_image erase main.bin 0x08000000
</source>

From there on, have a look at [[Quick_start]] for debugger commands.

== (Optional) Configuring the Netbeans IDE ==
To have a fully working code completion that can also resolve the board-specific symbols, right click on the project, go to Set Configuration and select the right board.

[[File: Netbeans-config.png]]

== SD Card (FIXME!!!!) ==

This board lacks an SD connector, so the filesystem support does not work out of the box (upon boot the kernel will say that filesystem mounting failed). However, it is possible to connect one to specific GPIO pins.

The SD or microSD connector VCC and GND pins need to be connected to 3V and GND pins on the board. Add a 100nF capacitor between VCC and GND, as close as possible to the SD connector. This will be useful to overcome current absorption peaks from the SD card.

Then connect the following GPIOs to the SD connector.

{| class="wikitable"
|-
! SD !! STM32 !! Optional
|-
| CLK || PC12 ||
|-
| CMD || PD2 ||
|-
| D0 || PC8 ||
|-
| D1 || PC9 || Y
|-
| D2 || PC10 || Y
|-
| D3 || PC11 || Y
|}

Each connection needs a pullup resistor between ~47Kohm and 100Kohm.

To increase read/write speed it is possible to connect the optional GPIOs thereby communicating with the SD in 4-bit mode.
Note that by default in this board the SD driver uses 1 bit mode. To enable 4-bit mode you need to edit the ''miosix/config/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/board_settings.h'' and comment out the ''#define SD_ONE_BIT_DATABUS'' line.

Also note that filesystem support is enabled by default, so the pins marked as not optional are used by the filesystem driver. If you do not want to connect an SD card, and want to use those GPIOs, you should disable the filesystem support in [[miosix_settings.h|miosix/config/miosix_settings.h]].

== Resource ==
stm32f4discovery [http://www2.st.com/content/ccc/resource/technical/document/user_manual/6b/25/05/23/a9/45/4d/6a/DM00093903.pdf/files/DM00093903.pdf/jcr:content/translations/en.DM00093903.pdf Datasheet]

[[Category:Boards]]

File:Stm32f429disco.jpg

2016-04-07T12:44:11Z

Silseva:

Stm32f429zi stm32f4discovery

2016-04-07T12:40:56Z

Silseva: Created STM32F429 discovery page

This is a cheap self contained [http://www2.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-eval-tools/stm32-mcu-eval-tools/stm32-mcu-discovery-kits/32f429idiscovery.html discovery board] with a powerful processor, and a Linux-friendly [http://www.st.com/web/catalog/tools/PF219866 ST-LINK/V2] programmer/in circuit debugger.
The board is equipped with
* A [http://www2.st.com/content/st_com/en/products/microcontrollers/stm32-32-bit-arm-cortex-mcus/stm32f4-series/stm32f429-439/stm32f429zi.html STM32F429ZI] microcontroller with a 180MHz ARM Cortex-M4F core, 2048KB Flash, 256KB RAM, 4KB battery-backed RAM in LQFP144 package.
* An external 64Mb SRAM, L3GD20 3-axis digital output gyroscope, 2.4" QVGA TFT LCD, 2 user LEDs, user button, reset button, a second USB connector as the microcontroller supports USB.

[[File:FIXME|frameless]]

== Configuring the kernel ==

The minimum configuration required is to edit the [[Makefile.inc|miosix/config/Makefile.inc]] file to uncomment the ''OPT_BOARD := stm32f429zi_stm32f4discovery'' line. If you had compiled the kernel before, it is recommended to do a ''make clean'' (or in the Netbeans IDE, to click on the "Clean project" button) to avoid leaving object files around. After, do a ''make'' to compile.

In addition, this board has a couple of board-specific options in the Makefile.inc file. For convenience, the relevant part of that configuration file is reported here so as to be easily located within the file

<source lang="CPP">
##---------------------------------------------------------------------------
## stm32f429zi_stm32f4discovery
##
ifeq ($(OPT_BOARD),stm32f429zi_stm32f4discovery)

## Linker script type, there are three options
## 1) Code in FLASH, stack + heap in internal RAM (file *_rom.ld)
## the most common choice, available for all microcontrollers
## 2) Code in FLASH, stack + heap in external RAM (file *8m_xram.ld)
## You must uncomment -D__ENABLE_XRAM below in this case.
## 3) Code in FLASH, stack + heap in external RAM (file *6m_xram.ld)
## Same as above, but leaves the upper 2MB of RAM for the LCD.
LINKER_SCRIPT_PATH := arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+256k_rom.ld
#LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+8m_xram.ld
LINKER_SCRIPT := $(LINKER_SCRIPT_PATH)stm32_2m+6m_xram.ld

## Uncommenting __ENABLE_XRAM enables the initialization of the external
## 8MB SDRAM memory. Do not uncomment this even if you don't use a linker
## script that requires it, as it is used for the LCD framebuffer.
XRAM := -D__ENABLE_XRAM

## Select clock frequency. Warning: the default clock frequency for
## this board is 168MHz and not 180MHz because, due to a limitation in
## the PLL, it is not possible to generate a precise 48MHz output when
## running the core at 180MHz. If 180MHz is chosen the USB peripheral will
## NOT WORK and the SDIO and RNG will run ~6% slower (45MHz insteand of 48)
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_180MHz=180000000
CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_168MHz=168000000
#CLOCK_FREQ := -DHSE_VALUE=8000000 -DSYSCLK_FREQ_100MHz=100000000

endif
</source>

As can be seen, there are two options for this board: LINKER_SCRIPT and SRAM_BOOT. The comments explain in detail the meaning of there options, so it isn't necessary to further explain them.

After modifying configuration files it is recommended to do a make clean; make (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

== Loading code ==

As explained before, there are more than one linker script for this board, and the selected linker script affects the way code should be loaded on the board.

== Reading printf output ==

The board has no serial to USB adapter onboard, so you need to use an external one, connected to USART3, in detail PA9 (TXD) and PA10 (RXD).

On Linux you can use screen. Open a terminal and type ''screen /dev/ttyUSB0 19200'' (Note that to quit from screen you need to type "Ctrl-C, \"). You'll need to change /dev/ttyUSB0 with your serial port device name.

On windows you can use HyperTerminal, you need to configure it to use the required baud rate, no flow control, and select the correct COM port device name.

== In Circuit Debugging ==

Before you begin you should note that the Miosix kernel will put the CPU to a low power state when no thread is running. This low power state will usually confuse debuggers and make them lose sync with the CPU. To avoid this you need to edit the [[miosix_settings.h|miosix/config/miosix_settings.h]] file and uncomment ''#define JTAG_DISABLE_SLEEP'' line. This will prevent the kernel from putting the CPU in its low power state making debugging possible.
Also, to be able to precisely single-step your code you need to disable compiler optimizations as gdb is incapable of reliably debug an optimized code. The option is in the miosix/config/Makefile.inc file and is the ''OPT_OPTIMIZATION := -O0'' that should be uncommented while the other lines related to the same option should be commented out.

After modifying configuration files it is recommended to do a ''make clean; make'' (or in the Netbeans IDE, to click on the "Clean and build project" button) to be sure that changes are applied.

Since the board has an on board SWD in circuit debugger, simply plugging the USB cable is all you need from an hardware point of view.
On the software side, you need to open two shells. In one do a

<source lang="BASH">
sudo openocd -f miosix/arch/cortexM4_stm32f4/stm32f429zi_stm32f4discovery/stm32f4discovery.cfg
</source>

This will start the OpenOCD program that will connect to the board and listen for GDB connections.

In the second shell type the following commands

<source lang="BASH">
arm-miosix-eabi-gdb main.elf
target remote :3333
monitor soft_reset_halt
break main
continue
</source>

The first command will start the gdb debugger. The following commands are typed into the gdb console, and tell it to connect to OpenOCD, and reset the board and stop the program at the beginning of main()
To load the program to be debugged, you can either do a make program before and then start debugging, or you can directly write the FLASH memory from within gdb with this command

<source lang="BASH">
monitor flash write_image erase main.bin 0x08000000
</source>

From there on, have a look at [[Quick_start]] for debugger commands.

== (Optional) Configuring the Netbeans IDE ==
To have a fully working code completion that can also resolve the board-specific symbols, right click on the project, go to Set Configuration and select the right board.

[[File: Netbeans-config.png]]

== SD Card (FIXME!!!!) ==

This board lacks an SD connector, so the filesystem support does not work out of the box (upon boot the kernel will say that filesystem mounting failed). However, it is possible to connect one to specific GPIO pins.

The SD or microSD connector VCC and GND pins need to be connected to 3V and GND pins on the board. Add a 100nF capacitor between VCC and GND, as close as possible to the SD connector. This will be useful to overcome current absorption peaks from the SD card.

Then connect the following GPIOs to the SD connector.

{| class="wikitable"
|-
! SD !! STM32 !! Optional
|-
| CLK || PC12 ||
|-
| CMD || PD2 ||
|-
| D0 || PC8 ||
|-
| D1 || PC9 || Y
|-
| D2 || PC10 || Y
|-
| D3 || PC11 || Y
|}

Each connection needs a pullup resistor between ~47Kohm and 100Kohm.

To increase read/write speed it is possible to connect the optional GPIOs thereby communicating with the SD in 4-bit mode.
Note that by default in this board the SD driver uses 1 bit mode. To enable 4-bit mode you need to edit the ''miosix/config/arch/cortexM4_stm32f4/stm32f407vg_stm32f4discovery/board_settings.h'' and comment out the ''#define SD_ONE_BIT_DATABUS'' line.

Also note that filesystem support is enabled by default, so the pins marked as not optional are used by the filesystem driver. If you do not want to connect an SD card, and want to use those GPIOs, you should disable the filesystem support in [[miosix_settings.h|miosix/config/miosix_settings.h]].

== Resource ==
stm32f4discovery [http://www2.st.com/content/ccc/resource/technical/document/user_manual/6b/25/05/23/a9/45/4d/6a/DM00093903.pdf/files/DM00093903.pdf/jcr:content/translations/en.DM00093903.pdf Datasheet]

[[Category:Boards]]