Miosix Wiki - User contributions [en]

File:Image024.jpg

2016-04-13T09:16:23Z

Lorenzo.pinosa:

File:Image022.jpg

2016-04-13T09:15:42Z

Lorenzo.pinosa:

File:Image020.jpg

2016-04-13T09:15:37Z

Lorenzo.pinosa:

File:Image019.jpg

2016-04-13T09:15:32Z

Lorenzo.pinosa:

File:Image017.jpg

2016-04-13T09:13:38Z

Lorenzo.pinosa:

File:Image015.jpg

2016-04-13T09:13:31Z

Lorenzo.pinosa:

File:Image013.jpg

2016-04-13T09:13:19Z

Lorenzo.pinosa:

File:Image011.jpg

2016-04-13T09:12:33Z

Lorenzo.pinosa: Lorenzo.pinosa uploaded a new version of File:Image011.jpg

File:Image011.jpg

2016-04-13T09:11:24Z

Lorenzo.pinosa:

File:Image009.jpg

2016-04-13T09:10:48Z

Lorenzo.pinosa:

File:Image007.jpg

2016-04-13T09:10:34Z

Lorenzo.pinosa:

File:Image005.jpg

2016-04-13T09:10:09Z

Lorenzo.pinosa:

VisualStudio Quick Start

2016-04-13T09:09:50Z

Lorenzo.pinosa:

= Installing VisualGDB, Miosix =

1. First of all, make sure to have installed Visual Studio, the supported versions are 2005-2015, exception made for the Express Editions that are not supported. If you need Visual Studio, you can download the 2015 Community Edition, that is free.

2.
Let’s get the environment ready for Miosix. Go to [[https://miosix.org/wiki/index.php?title=Windows_Quick_Start]] and complete the steps “Before you begin”, “Install the Miosix Toolchain”, “Get the Miosix kernel sources”. Now
enter the miosix-kernel folder and complete the “Configuring the kernel” step.
If you work with many boards, you would better clone the kernel many times in
different folders (one folder for each board) and repeat the “Configuring the
kernel” step for each folder. In the file miosix/config/Makefile.inc please make
sure that all variables OPT_OPTIMIZATION are commented out.

3.
Close
Visual Studio if it’s open.

4.
Download
VisualGDB from [[http://visualgdb.com/download/]] and install it by following the
wizard.

5.
Open
Visual Studio

6.
The
following prompt will appear:
[[File:Image001.jpg|thumbnail]]

Answer Yes to continue.

7.
Another
popup will notify you of the operation success and ask to restart Visual
Studio. Do it.

8.
Another
VisualGDB screen will appear asking for your license details. For the moment
you can start a trial (full featured for 30 days) or enter your license key.

9.
Now
you are prompted to choose wheter to use the VisualGDB-provided IntelliSense or
continue to use the default Visual Studio Intellisense.
[[File:image003.jpg|thumbnail]]
I recommend the Visual Studio IntelliSense. Uncheck the checkbox “enable
the engine..” and the “Show this dialog when VS
starts” one too.

= 2 Creating a new project =

You
have to repeat this walkthrough every time you would like to create a new
project based on miosix. If you feel that the procedure is too long, you can
make a project stub for each platform/board you work with, and then reuse it as
many times you want by copying it.

1.
In
Visual Studio, choose File -> New -> Project. Pick VisualGDB from the
project templates and then select “Embedded Project”.[[File:image005.jpg|thumbnail]]

2.
If
the project path contains spaces, you are warned about it. I strongly recommend
to put the project in a path that doesn’t contain spaces.

3.
The
VisualGDB wizard appears.[[File:image007.jpg|thumbnail]]

Here you can choose the desired output files. They will be put in the
bin folder of the project, as for all other VS projects. Those files will be
useful to you only if you need to send or publish them, since VisualGDB
automatically deploys the project to the board when you run the project. Hit
Next.

4.
The
Device Selection Screen appears. Before searching for your SoC from the list,
you have to download the ARM toolchain. Due to changes that we will make later,
that toolchain won’t be used to compile your project (Miosix toolchain will be
used instead) but only to debug it. This has to be done only one time.

[[File:image009.jpg|thumbnail]]Select ARM from the dropdown list
and proceed with download after you have selected the latest version.

Once completed, you will be asked to install device support files.
Answer yes and download the support package you need. [[File:image011.jpg|thumbnail]][[File:image013.jpg|thumbnail]]Now
select your device from the list and hit next. Note that you will need to
select the model of SoC on which your board is based and not the model of the
board itself.

5.
Leave
the settings of the Sample Selection screen to their defaults, since we will
delete all those files. Continue to the next screen.

6.
Now
it’s time to connect your board to the computer and verify that VisualGDB can
connect to it. Start by installing OpenOCD by pressing “Install support for
additional debug methods” at the bottom of the screen, selecting OpenOCD and
clicking OK. You can also install other debuggers if you need them.[[File:image015.jpg|thumbnail]]

Now select from the top dropdown list “Debug method” OpenOCD.

Press “Detect” on the right and VisualGDB will try to connect to your
board and configure OpenOCD. [[File:image017.jpg|thumbnail]]Test if all is working correctly by
pressing “Test OpenOCD settings”. You can click finish and wait for the project
to be created. We are not done yet.

7.
In
Visual Studio, once the project is loaded, right click the project in Solution
Explorer and choose “VisualGDB Project Properties”. In the window that appears,
choose Embedded Frameworks from the left and then uncheck “STM32F4Cube HAL”. [[File:image019.jpg|thumbnail]]

Apply the changes and close the window by pressing OK. Go back focusing
the Solution Explorer panel. Delete from the project the files system_stm32f4xx.c,
stm32f4xx_hal_conf.h, startup_stm32f429xx.c, LEDBlink.cpp.

[[File:image020.jpg|thumbnail]]

8.
It’s
time to integrate Miosix in the project. Open the project in Windows Explorer
and copy to the project folder the miosix folder (and not the miosix-kernel
folder) you got in step 1.2. Now replace debug.mak, release.mak and Makefile in
the project folder with those provided with miosix kernel.

9.
We
are almost ready. Now let’s make the IntelliSense working by specifying the
correct miosix folders where to look for .h files. Open a command prompt in the
project directory (just right click the project in VS, choose Show in Explorer,
and from there right click while pressing SHIFT -> Open command prompt here)
and type make print-includes . Select the includes
printed and press enter to copy the text. Now go back to VS, right click the
project, choose Properties (last entry) and then Configuration properties ->
NMake. At the very end of Inclusion file search path, paste the includes you
have copied before. [[File:image022.jpg|thumbnail]]

10.
Lastly,
we need to tell VisualGDB where to find Perl and the Miosix toolchain. If you
haven’t those directories on the PATH variable of your system, or the
compilation phase complains about executables not found, proceed with this
step, otherwise skip.

Right click the project in Solution Explorer, choose “VisualGDB Project
Properties”. In the window that appears, choose Makefile Settings from the left
and then, under “Build Tools”, press Customize at the right of “Make command”. Now
concatenate to PATH=C:\SysGCC\arm-eabi\bin;%PATH% the
paths of your Perl installation and Miosix toolchain installation. You should
end up with something like: PATH=C:\SysGCC\arm-eabi\bin;%PATH%;C:\Strawberry\perl\bin;C:\arm-miosix-eabi\bin[[File:image024.jpg|thumbnail]]

11.
Create
a new main.cpp file and you are ready to go! If you like, you can copy to the
root of the project the main.cpp file provided with miosix, and include it in
the project to get started quicker. To do so, once you copied the file, choose
“show all files” in Solution Explorer, then right click main.cpp and select
“Include in the project”.

= 3 Customizing compilation =

You
can use the release.mak and debug.mak Makefiles to tune the compilation process
for both Debug and Release configurations.

Use TOOLCHAIN_ROOT
to specify Miosix toolchain location.

Use the INCLUDE_DIRS, LIBRARY_DIRS, LIBRARY_NAMES, STATIC_LIBS variables to specify your additional libraries.
Includes for mxgui library are already present, remove them if you don’t plan
to use that library.

File:Image003.jpg

2016-04-13T09:09:11Z

Lorenzo.pinosa:

VisualStudio Quick Start

2016-04-13T09:08:58Z

Lorenzo.pinosa:

= Installing VisualGDB, Miosix =

1. First of all, make sure to have installed Visual Studio, the supported versions are 2005-2015, exception made for the Express Editions that are not supported. If you need Visual Studio, you can download the 2015 Community Edition, that is free.

2.
Let’s get the environment ready for Miosix. Go to [[https://miosix.org/wiki/index.php?title=Windows_Quick_Start]] and complete the steps “Before you begin”, “Install the Miosix Toolchain”, “Get the Miosix kernel sources”. Now
enter the miosix-kernel folder and complete the “Configuring the kernel” step.
If you work with many boards, you would better clone the kernel many times in
different folders (one folder for each board) and repeat the “Configuring the
kernel” step for each folder. In the file miosix/config/Makefile.inc please make
sure that all variables OPT_OPTIMIZATION are commented out.

3.
Close
Visual Studio if it’s open.

4.
Download
VisualGDB from [[http://visualgdb.com/download/]] and install it by following the
wizard.

5.
Open
Visual Studio

6.
The
following prompt will appear:
[[File:Image001.jpg|thumbnail]]

Answer Yes to continue.

7.
Another
popup will notify you of the operation success and ask to restart Visual
Studio. Do it.

8.
Another
VisualGDB screen will appear asking for your license details. For the moment
you can start a trial (full featured for 30 days) or enter your license key.

9.
Now
you are prompted to choose wheter to use the VisualGDB-provided IntelliSense or
continue to use the default Visual Studio Intellisense.

[[File:image003.jpg|thumbnail]]

I recommend the Visual Studio IntelliSense. Uncheck the checkbox “enable
the engine..” and the “Show this dialog when VS
starts” one too.

= 2 Creating a new project =

You
have to repeat this walkthrough every time you would like to create a new
project based on miosix. If you feel that the procedure is too long, you can
make a project stub for each platform/board you work with, and then reuse it as
many times you want by copying it.

1.
In
Visual Studio, choose File -> New -> Project. Pick VisualGDB from the
project templates and then select “Embedded Project”.[[File:image005.jpg|thumbnail]]

2.
If
the project path contains spaces, you are warned about it. I strongly recommend
to put the project in a path that doesn’t contain spaces.

3.
The
VisualGDB wizard appears.[[File:image007.jpg|thumbnail]]

Here you can choose the desired output files. They will be put in the
bin folder of the project, as for all other VS projects. Those files will be
useful to you only if you need to send or publish them, since VisualGDB
automatically deploys the project to the board when you run the project. Hit
Next.

4.
The
Device Selection Screen appears. Before searching for your SoC from the list,
you have to download the ARM toolchain. Due to changes that we will make later,
that toolchain won’t be used to compile your project (Miosix toolchain will be
used instead) but only to debug it. This has to be done only one time.

[[File:image009.jpg|thumbnail]]Select ARM from the dropdown list
and proceed with download after you have selected the latest version.

Once completed, you will be asked to install device support files.
Answer yes and download the support package you need. [[File:image011.jpg|thumbnail]][[File:image013.jpg|thumbnail]]Now
select your device from the list and hit next. Note that you will need to
select the model of SoC on which your board is based and not the model of the
board itself.

5.
Leave
the settings of the Sample Selection screen to their defaults, since we will
delete all those files. Continue to the next screen.

6.
Now
it’s time to connect your board to the computer and verify that VisualGDB can
connect to it. Start by installing OpenOCD by pressing “Install support for
additional debug methods” at the bottom of the screen, selecting OpenOCD and
clicking OK. You can also install other debuggers if you need them.[[File:image015.jpg|thumbnail]]

Now select from the top dropdown list “Debug method” OpenOCD.

Press “Detect” on the right and VisualGDB will try to connect to your
board and configure OpenOCD. [[File:image017.jpg|thumbnail]]Test if all is working correctly by
pressing “Test OpenOCD settings”. You can click finish and wait for the project
to be created. We are not done yet.

7.
In
Visual Studio, once the project is loaded, right click the project in Solution
Explorer and choose “VisualGDB Project Properties”. In the window that appears,
choose Embedded Frameworks from the left and then uncheck “STM32F4Cube HAL”. [[File:image019.jpg|thumbnail]]

Apply the changes and close the window by pressing OK. Go back focusing
the Solution Explorer panel. Delete from the project the files system_stm32f4xx.c,
stm32f4xx_hal_conf.h, startup_stm32f429xx.c, LEDBlink.cpp.

[[File:image020.jpg|thumbnail]]

8.
It’s
time to integrate Miosix in the project. Open the project in Windows Explorer
and copy to the project folder the miosix folder (and not the miosix-kernel
folder) you got in step 1.2. Now replace debug.mak, release.mak and Makefile in
the project folder with those provided with miosix kernel.

9.
We
are almost ready. Now let’s make the IntelliSense working by specifying the
correct miosix folders where to look for .h files. Open a command prompt in the
project directory (just right click the project in VS, choose Show in Explorer,
and from there right click while pressing SHIFT -> Open command prompt here)
and type make print-includes . Select the includes
printed and press enter to copy the text. Now go back to VS, right click the
project, choose Properties (last entry) and then Configuration properties ->
NMake. At the very end of Inclusion file search path, paste the includes you
have copied before. [[File:image022.jpg|thumbnail]]

10.
Lastly,
we need to tell VisualGDB where to find Perl and the Miosix toolchain. If you
haven’t those directories on the PATH variable of your system, or the
compilation phase complains about executables not found, proceed with this
step, otherwise skip.

Right click the project in Solution Explorer, choose “VisualGDB Project
Properties”. In the window that appears, choose Makefile Settings from the left
and then, under “Build Tools”, press Customize at the right of “Make command”. Now
concatenate to PATH=C:\SysGCC\arm-eabi\bin;%PATH% the
paths of your Perl installation and Miosix toolchain installation. You should
end up with something like: PATH=C:\SysGCC\arm-eabi\bin;%PATH%;C:\Strawberry\perl\bin;C:\arm-miosix-eabi\bin[[File:image024.jpg|thumbnail]]

11.
Create
a new main.cpp file and you are ready to go! If you like, you can copy to the
root of the project the main.cpp file provided with miosix, and include it in
the project to get started quicker. To do so, once you copied the file, choose
“show all files” in Solution Explorer, then right click main.cpp and select
“Include in the project”.

= 3 Customizing compilation =

You
can use the release.mak and debug.mak Makefiles to tune the compilation process
for both Debug and Release configurations.

Use TOOLCHAIN_ROOT
to specify Miosix toolchain location.

Use the INCLUDE_DIRS, LIBRARY_DIRS, LIBRARY_NAMES, STATIC_LIBS variables to specify your additional libraries.
Includes for mxgui library are already present, remove them if you don’t plan
to use that library.

File:Image001.jpg

2016-04-13T09:02:38Z

Lorenzo.pinosa:

VisualStudio Quick Start

2016-04-13T09:01:19Z

Lorenzo.pinosa: Created page with "= Installing VisualGDB, Miosix = 1. First of all, make sure to have installed Visual Studio, the supported versions are 2005-2015, exception made for the Express Editions th..."

= Installing VisualGDB, Miosix =

1. First of all, make sure to have installed Visual Studio, the supported versions are 2005-2015, exception made for the Express Editions that are not supported. If you need Visual Studio, you can download the 2015 Community Edition, that is free.

2.
Let’s get the environment ready for Miosix. Go to [[https://miosix.org/wiki/index.php?title=Windows_Quick_Start]] and complete the steps “Before you begin”, “Install the Miosix Toolchain”, “Get the Miosix kernel sources”. Now
enter the miosix-kernel folder and complete the “Configuring the kernel” step.
If you work with many boards, you would better clone the kernel many times in
different folders (one folder for each board) and repeat the “Configuring the
kernel” step for each folder. In the file miosix/config/Makefile.inc please make
sure that all variables OPT_OPTIMIZATION are commented out.

3.
Close
Visual Studio if it’s open.

4.
Download
VisualGDB from [[http://visualgdb.com/download/]] and install it by following the
wizard.

5.
Open
Visual Studio

6.
The
following prompt will appear:[[Image:image001.jpg]]

Answer Yes to continue.

7.
Another
popup will notify you of the operation success and ask to restart Visual
Studio. Do it.

8.
Another
VisualGDB screen will appear asking for your license details. For the moment
you can start a trial (full featured for 30 days) or enter your license key.

9.
Now
you are prompted to choose wheter to use the VisualGDB-provided IntelliSense or
continue to use the default Visual Studio Intellisense.

[[Image:image003.jpg]]

I recommend the Visual Studio IntelliSense. Uncheck the checkbox “enable
the engine..” and the “Show this dialog when VS
starts” one too.

= 2 Creating a new project =

You
have to repeat this walkthrough every time you would like to create a new
project based on miosix. If you feel that the procedure is too long, you can
make a project stub for each platform/board you work with, and then reuse it as
many times you want by copying it.

1.
In
Visual Studio, choose File -> New -> Project. Pick VisualGDB from the
project templates and then select “Embedded Project”.[[Image:image005.jpg]]

2.
If
the project path contains spaces, you are warned about it. I strongly recommend
to put the project in a path that doesn’t contain spaces.

3.
The
VisualGDB wizard appears.[[Image:image007.jpg]]

Here you can choose the desired output files. They will be put in the
bin folder of the project, as for all other VS projects. Those files will be
useful to you only if you need to send or publish them, since VisualGDB
automatically deploys the project to the board when you run the project. Hit
Next.

4.
The
Device Selection Screen appears. Before searching for your SoC from the list,
you have to download the ARM toolchain. Due to changes that we will make later,
that toolchain won’t be used to compile your project (Miosix toolchain will be
used instead) but only to debug it. This has to be done only one time.

[[Image:image009.jpg]]Select ARM from the dropdown list
and proceed with download after you have selected the latest version.

Once completed, you will be asked to install device support files.
Answer yes and download the support package you need. [[Image:image011.jpg]][[Image:image013.jpg]]Now
select your device from the list and hit next. Note that you will need to
select the model of SoC on which your board is based and not the model of the
board itself.

5.
Leave
the settings of the Sample Selection screen to their defaults, since we will
delete all those files. Continue to the next screen.

6.
Now
it’s time to connect your board to the computer and verify that VisualGDB can
connect to it. Start by installing OpenOCD by pressing “Install support for
additional debug methods” at the bottom of the screen, selecting OpenOCD and
clicking OK. You can also install other debuggers if you need them.[[Image:image015.jpg]]

Now select from the top dropdown list “Debug method” OpenOCD.

Press “Detect” on the right and VisualGDB will try to connect to your
board and configure OpenOCD. [[Image:image017.jpg]]Test if all is working correctly by
pressing “Test OpenOCD settings”. You can click finish and wait for the project
to be created. We are not done yet.

7.
In
Visual Studio, once the project is loaded, right click the project in Solution
Explorer and choose “VisualGDB Project Properties”. In the window that appears,
choose Embedded Frameworks from the left and then uncheck “STM32F4Cube HAL”. [[Image:image019.jpg]]

Apply the changes and close the window by pressing OK. Go back focusing
the Solution Explorer panel. Delete from the project the files system_stm32f4xx.c,
stm32f4xx_hal_conf.h, startup_stm32f429xx.c, LEDBlink.cpp.

[[Image:image020.jpg]]

8.
It’s
time to integrate Miosix in the project. Open the project in Windows Explorer
and copy to the project folder the miosix folder (and not the miosix-kernel
folder) you got in step 1.2. Now replace debug.mak, release.mak and Makefile in
the project folder with those provided with miosix kernel.

9.
We
are almost ready. Now let’s make the IntelliSense working by specifying the
correct miosix folders where to look for .h files. Open a command prompt in the
project directory (just right click the project in VS, choose Show in Explorer,
and from there right click while pressing SHIFT -> Open command prompt here)
and type make print-includes . Select the includes
printed and press enter to copy the text. Now go back to VS, right click the
project, choose Properties (last entry) and then Configuration properties ->
NMake. At the very end of Inclusion file search path, paste the includes you
have copied before. [[Image:image022.jpg]]

10.
Lastly,
we need to tell VisualGDB where to find Perl and the Miosix toolchain. If you
haven’t those directories on the PATH variable of your system, or the
compilation phase complains about executables not found, proceed with this
step, otherwise skip.

Right click the project in Solution Explorer, choose “VisualGDB Project
Properties”. In the window that appears, choose Makefile Settings from the left
and then, under “Build Tools”, press Customize at the right of “Make command”. Now
concatenate to PATH=C:\SysGCC\arm-eabi\bin;%PATH% the
paths of your Perl installation and Miosix toolchain installation. You should
end up with something like: PATH=C:\SysGCC\arm-eabi\bin;%PATH%;C:\Strawberry\perl\bin;C:\arm-miosix-eabi\bin[[Image:image024.jpg]]

11.
Create
a new main.cpp file and you are ready to go! If you like, you can copy to the
root of the project the main.cpp file provided with miosix, and include it in
the project to get started quicker. To do so, once you copied the file, choose
“show all files” in Solution Explorer, then right click main.cpp and select
“Include in the project”.

= 3 Customizing compilation =

You
can use the release.mak and debug.mak Makefiles to tune the compilation process
for both Debug and Release configurations.

Use TOOLCHAIN_ROOT
to specify Miosix toolchain location.

Use the INCLUDE_DIRS, LIBRARY_DIRS, LIBRARY_NAMES, STATIC_LIBS variables to specify your additional libraries.
Includes for mxgui library are already present, remove them if you don’t plan
to use that library.

Quick start

2016-04-13T08:41:53Z

Lorenzo.pinosa: Add entry for Visual Studio Getting Started

To start using Miosix you need a patched version of the GCC compiler called [[Miosix Toolchain]] and git to download the kernel sources. Optionally you can also use an IDE to simplify code development, and an in-circuit debugger to speed up bug fixing.

''' Changes with respect to Miosix 1.x '''

A word of warning if you are a long-time user of Miosix: please note that in Miosix 2.0 there were significant changes.
First of all, Miosix 2.0 uses GCC 4.7.3 and is no longer compatible with the old GCC 4.5.2 used in Miosix 1.x, so you need to upgrade your compiler.
Second, the preferred way to install the compiler is through a precompiled installer available for both Linux and Windows. If you want, though, you can still build the compiler from sources.
Last, keep in mind that the compiler patches are still a work in progress. When doing a 'git pull' you may need to upgrade the compiler too.

=== Getting started ===

This section will guide you through the installation of the minimum requirements to start using Miosix: installing the compiler, and downloading the kernel.

* [[Linux Quick Start|Getting Started on Linux]]
* [[Windows Quick Start|Getting Started on Windows]]
* [[VisualStudio Quick Start|Getting Started on Windows with Visual Studio]]
* [[OSX Quick Start|Getting Started on OSX]]

=== IDE Configuration ===

The default IDE to develop for Miosix is [https://netbeans.org/ Netbeans]. However, it does not come with Miosix support out of the box, so you have to configure it first.

* [[Linux Netbeans configuration]]
* [[Windows Netbeans configuration]]
* [[OSX Netbeans configuration]]

Another alternative is [[Linux Eclipse configuration|Eclipse]], which has the added feature to allow in-circuit debugging directly from the IDE.

You can also use [http://www.qt.io QtCreator].

* [[Linux QtCreator configuration]]
* [[Windows QtCreator configuration]]

=== Miosix and git workflow ===

See [[Miosix and git workflow]] to understand how to manage the Miosix git repository.

=== In-circuit debugger ===

An in-circuit debugger allows to physically halt the CPU inside a microcontroller, single-step it and view all the variables at any given time. It is a powerful tool to debug software running on a microcontroller. Miosix uses GDB and [http://openocd.sourceforge.net openocd] for in-circuit debugging.

* [[Linux Debugger configuration]]
* [[Windows Debugger configuration]]

[[Category:Installation and Configuration]]