Installing the Cross Tools for ARM

This page shows you how to install the tools to build, run, and debug Mynewt OS applications that run on supported ARM target boards. It shows you how to install the following tools on Mac OS, Linux and Windows:

  • ARM cross toolchain to compile and build Mynewt applications for the target boards.

  • Debuggers to load and debug applications on the target boards.

Installing the ARM Cross Toolchain

ARM maintains a pre-built GNU toolchain with gcc and gdb targeted at Embedded ARM Processors, namely Cortex-R/Cortex-M processor families. Mynewt OS has been tested with version 4.9 of the toolchain and we recommend you install this version to get started. Mynewt OS will eventually work with multiple versions available, including the latest releases.

Installing the ARM Toolchain For Mac OS X

Add the PX4/homebrew-px4 homebrew tap and install version 4.9 of the toolchain. After installing, check that the symbolic link that homebrew created points to the correct version of the debugger.

$ brew tap PX4/homebrew-px4
$ brew update
$ brew install gcc-arm-none-eabi-49
$ arm-none-eabi-gcc --version
arm-none-eabi-gcc (GNU Tools for ARM Embedded Processors) 4.9.3 20150529 (release) [ARM/embedded-4_9-branch revision 224288]
Copyright (C) 2014 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
$ ls -al /usr/local/bin/arm-none-eabi-gdb
lrwxr-xr-x  1 aditihilbert  admin  69 Sep 22 17:16 /usr/local/bin/arm-none-eabi-gdb -> /usr/local/Cellar/gcc-arm-none-eabi-49/20150609/bin/arm-none-eabi-gdb

Note: If no version is specified, brew will install the latest version available.

Installing the ARM Toolchain For Linux

On a Debian-based Linux distribution, gcc 4.9.3 for ARM can be installed with apt-get as documented below. The steps are explained in depth at https://launchpad.net/~team-gcc-arm-embedded/+archive/ubuntu/ppa.

$ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
$ sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
$ sudo apt-get update
$ sudo apt-get install gcc-arm-none-eabi
$ sudo apt-get install gdb-arm-none-eabi

Installing the ARM Toolchain for Windows

  1. Download and run the installer to install arm-none-eabi-gcc and arm-none-eabi-gdb. Select the default destination folder: C:\Program Files (x86)\GNU Arm Embedded Toolchain\10 2020-q4-major.

    Notes:

    • Check the Add path to environment variable option before you click the Finish button for the installation.

    • You may select a different folder but the installation instructions use the default values.

  2. Check that you are using the installed versions arm-none-eabi-gcc and arm-none-eabi-gdb. Open a MinGW terminal and run the which commands.

    Note: You must start a new MinGW terminal to inherit the new Path values.

    $ which arm-none-eabi-gcc
    /c/Program Files (x86)/GNU Arm Embedded Toolchain/10 2020-q4-major/bin/arm-none-eabi-gcc
    $ which arm-none-eabi-gdb
    /c/Program Files (x86)/GNU Arm Embedded Toolchain/10 2020-q4-major/bin/arm-none-eabi-gdb
    

Installing the Debuggers

Mynewt uses, depending on the board, either the OpenOCD or SEGGER J-Link debuggers.

Installing the OpenOCD Debugger

OpenOCD (Open On-Chip Debugger) is open-source software that allows your computer to interface with the JTAG debug connector on a variety of boards. A JTAG connection lets you debug and test embedded target devices. For more on OpenOCD go to http://openocd.org.

OpenOCD version 0.10.0 with nrf52 support is required. A binary for this version is available to download for Mac OS, Linux, and Windows.

Installing OpenOCD on Mac OS

  1. Install latest OpenOCD from Homebrew:

$ brew update
$ brew install open-ocd --HEAD
  1. Check the OpenOCD version you are using:

    $ which openocd
    /usr/local/bin/openocd
    
    $ openocd -v
    Open On-Chip Debugger 0.10.0
    Licensed under GNU GPL v2
    For bug reports, read
    http://openocd.org/doc/doxygen/bugs.html
    

    You should see version: 0.10.0+dev-<latest#>.

Installing OpenOCD on Linux

  1. Download the binary tarball for Linux

  2. Change to the root directory:

    $ cd /
    
  3. Untar the tarball and install into /usr/local/bin. You will need to replace ~/Downloads with the directory that the tarball is downloaded to.

    Note: You must specify the -p option for the tar command.

    $ sudo tar -xpf ~/Downloads/openocd-bin-0.10.0-Linux.tgz
    
  4. Check the OpenOCD version you are using:

    $ which openocd
    /usr/local/bin/openocd
    $ openocd -v
    Open On-Chip Debugger 0.10.0
    Licensed under GNU GPL v2
    For bug reports, read
    http://openocd.org/doc/doxygen/bugs.html
    

    You should see version: 0.10.0.

    If you see any of these error messages:

    • openocd: error while loading shared libraries: libhidapi-hidraw.so.0: cannot open shared object file: No such file or directory

    • openocd: error while loading shared libraries: libusb-1.0.so.0: cannot open shared object file: No such file or directory

    run the following command to install the libraries:

    $ sudo apt-get install libhidapi-dev:i386
    

Installing OpenOCD on Windows

  1. Download the binary zip file for Windows.

  2. Extract into the C:\openocd-0.10.0 folder.

  3. Add the path: C:\openocd-0.10.0\bin to your Windows User Path environment variable. Note: You must add bin to the path.

  4. Check the OpenOCD version you are using. Open a new MinGW terminal and run the following commands:

    Note: You must start a new MinGW terminal to inherit the new Path values.

    $ which openocd
    /c/openocd-0.10.0/bin/openocd
    $ openocd -v
    Open On-Chip Debugger 0.10.0
    Licensed under GNU GPL v2
    For bug reports, read
            http://openocd.org/doc/doxygen/bugs.html
    

    You should see version: 0.10.0.