164 lines
5.3 KiB
ReStructuredText
164 lines
5.3 KiB
ReStructuredText
.. _installation_linux:
|
|
|
|
Development Environment Setup on Linux
|
|
######################################
|
|
|
|
This section describes how to set up a Linux development system.
|
|
|
|
After completing these steps, you will be able to compile and run your Zephyr
|
|
applications on the following Linux distributions:
|
|
|
|
* Ubuntu 16.04 LTS 64-bit
|
|
* Fedora 25 64-bit
|
|
|
|
Where needed, alternative instructions are listed for Ubuntu and Fedora.
|
|
|
|
Installing the Host's Operating System
|
|
**************************************
|
|
|
|
Building the project's software components including the kernel has been
|
|
tested on Ubuntu and Fedora systems. Instructions for installing these OSes
|
|
are beyond the scope of this document.
|
|
|
|
Update Your Operating System
|
|
****************************
|
|
|
|
Before proceeding with the build, ensure your OS is up to date. On Ubuntu,
|
|
you'll first need to update the local database list of available packages
|
|
before upgrading:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo apt-get update
|
|
sudo apt-get upgrade
|
|
|
|
On Fedora:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo dnf upgrade
|
|
|
|
Note that having a newer version available for an installed package
|
|
(and reported by ``dnf check-update``) does not imply a subsequent
|
|
``dnf upgrade`` will install it, because it must also ensure dependencies
|
|
and other restrictions are satisfied.
|
|
|
|
Installing Requirements and Dependencies
|
|
****************************************
|
|
|
|
Install the following with either apt-get or dnf.
|
|
|
|
Install the required packages in a Ubuntu host system with:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo apt-get install --no-install-recommends git cmake ninja-build gperf \
|
|
ccache doxygen dfu-util device-tree-compiler \
|
|
python3-ply python3-pip python3-setuptools xz-utils file make gcc-multilib
|
|
|
|
Install the required packages in a Fedora host system with:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo dnf group install "Development Tools"
|
|
sudo dnf install git cmake ninja-build gperf ccache\
|
|
doxygen dfu-util dtc python3-pip \
|
|
python3-ply python3-yaml dfu-util dtc python3-pykwalify
|
|
|
|
Install additional packages required for development with Zephyr::
|
|
|
|
cd ~/zephyr # or to your directory where zephyr is cloned
|
|
pip3 install --user -r scripts/requirements.txt
|
|
|
|
CMake version 3.8.2 or higher is required. Check what version you have using
|
|
``cmake --version``, and if its an older version, check the backports or
|
|
install a more recent version manually. For example, to install version
|
|
3.8.2 from the CMake website directly in ~/cmake::
|
|
|
|
mkdir $HOME/cmake && cd $HOME/cmake
|
|
wget https://cmake.org/files/v3.8/cmake-3.8.2-Linux-x86_64.sh
|
|
yes | sh cmake-3.8.2-Linux-x86_64.sh | cat
|
|
echo "export PATH=$PWD/cmake-3.8.2-Linux-x86_64/bin:\$PATH" >> $HOME/.zephyrrc
|
|
source <zephyr git clone location>/zephyr-env.sh
|
|
cmake --version
|
|
|
|
.. _zephyr_sdk:
|
|
|
|
Installing the Zephyr Software Development Kit
|
|
==============================================
|
|
|
|
Zephyr's :abbr:`SDK (Software Development Kit)` contains all necessary tools
|
|
and cross-compilers needed to build the kernel on all supported
|
|
architectures. Additionally, it includes host tools such as a custom QEMU and
|
|
a host compiler for building host tools if necessary. The SDK supports the
|
|
following architectures:
|
|
|
|
* :abbr:`X86 (Intel Architecture 32 bits)`
|
|
|
|
* :abbr:`X86 IAMCU ABI (Intel Architecture 32 bits IAMCU ABI)`
|
|
|
|
* :abbr:`ARM (Advanced RISC Machines)`
|
|
|
|
* :abbr:`ARC (Argonaut RISC Core)`
|
|
|
|
* :abbr:`NIOS II`
|
|
|
|
* :abbr:`Xtensa`
|
|
|
|
* :abbr:`RISC-V`
|
|
|
|
Follow these steps to install the SDK on your Linux host system.
|
|
|
|
#. Download the latest SDK self-extractable binary.
|
|
|
|
Visit the `Zephyr SDK archive`_ to find all available SDK versions,
|
|
including the latest version.
|
|
|
|
Alternatively, you can use the following command to download the
|
|
desired version (*0.9.2* can be replaced with the version number you
|
|
wish to download).
|
|
|
|
.. code-block:: console
|
|
|
|
wget https://github.com/zephyrproject-rtos/meta-zephyr-sdk/releases/download/0.9.2/zephyr-sdk-0.9.2-setup.run
|
|
|
|
#. Run the installation binary, follow this example:
|
|
|
|
.. important::
|
|
Make sure you have installed all required packages for your host
|
|
distribution as described in the previous section
|
|
`Installing Requirements and Dependencies`_ otherwise the SDK installation will fail.
|
|
|
|
.. code-block:: console
|
|
|
|
sh zephyr-sdk-<version>-setup.run
|
|
|
|
There is no need to use ``sudo`` if the SDK is installed in the current
|
|
user's home directory.
|
|
|
|
#. Follow the installation instructions on the screen. The
|
|
toolchain's default installation location is :file:`/opt/zephyr-sdk/`.
|
|
To install in the default installation location, you will need to use sudo. It is recommended
|
|
to install the SDK in your home directory and not in a system directory.
|
|
|
|
#. To use the Zephyr SDK, export the following environment variables and
|
|
use the target location where SDK was installed, type:
|
|
|
|
.. code-block:: console
|
|
|
|
export ZEPHYR_GCC_VARIANT=zephyr
|
|
export ZEPHYR_SDK_INSTALL_DIR=<sdk installation directory>
|
|
|
|
To use the same toolchain in new sessions in the future you can set the
|
|
variables in the file :file:`${HOME}/.zephyrrc`, for example:
|
|
|
|
.. code-block:: console
|
|
|
|
cat <<EOF > ~/.zephyrrc
|
|
export ZEPHYR_GCC_VARIANT=zephyr
|
|
export ZEPHYR_SDK_INSTALL_DIR=/opt/zephyr-sdk
|
|
EOF
|
|
|
|
.. _Zephyr SDK archive:
|
|
https://www.zephyrproject.org/developers/#downloads
|