Miosix Wiki - User contributions [en]

MacOS Quick Start

2015-11-22T00:24:09Z

Alessandro.Pappalardo:

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
</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>

MacOS Quick Start

2015-11-22T00:17:51Z

Alessandro.Pappalardo: /* Toolchain compilation and installation */

MacOS Quick Start

2015-11-22T00:16:57Z

Alessandro.Pappalardo:

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
</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>

MacOS Quick Start

2015-11-22T00:15:28Z

Alessandro.Pappalardo:

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
</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>

MacOS Quick Start

2015-11-22T00:11:48Z

Alessandro.Pappalardo: /* Toolchain compilation and installation */

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 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
</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>

MacOS Quick Start

2015-11-22T00:10:29Z

Alessandro.Pappalardo: /* Toolchain installation */

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 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
</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 and installation'''

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>

Now you need to add it 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>

MacOS Quick Start

2015-11-22T00:09:44Z

Alessandro.Pappalardo:

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 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 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
</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 and installation'''

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>

Now you need to add it 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>

MacOS Quick Start

2015-11-21T23:17:53Z

Alessandro.Pappalardo:

MacOS Quick Start

2015-11-21T22:23:05Z

Alessandro.Pappalardo:

MacOS Quick Start

2015-11-21T22:21:18Z

Alessandro.Pappalardo: Created page with "=== 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..."

=== 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 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].

=== GCC 4.9.3 installation ===

'''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 grab the most recent packages list:

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

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 to install GCC 4.9.3:

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

Quick start

2015-11-19T23:01:19Z

Alessandro.Pappalardo: Add OS X "Getting Started" and "Netbeans configuration" page references.

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]]
* [[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]]