Added how to install openocd binary. Added information about installing J-Link Added the specific debugger to install in prerequisites to blinky and slinky tutorials. Removed STM32F303 from list of blinky tutorials
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/0c750d32 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/0c750d32 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/0c750d32 Branch: refs/heads/develop Commit: 0c750d3210b9217b291cfa5ea881adeed1a9a2cc Parents: 2aa8532 Author: cwanda <[email protected]> Authored: Fri Apr 14 21:04:49 2017 -0700 Committer: aditihilbert <[email protected]> Committed: Tue Apr 25 13:03:34 2017 -0700 ---------------------------------------------------------------------- docs/os/get_started/cross_tools.md | 103 +++++++++++++++++-------- docs/os/tutorials/arduino_zero.md | 1 + docs/os/tutorials/blinky.md | 1 - docs/os/tutorials/blinky_primo.md | 18 +---- docs/os/tutorials/nRF52.md | 1 + docs/os/tutorials/olimex.md | 2 + docs/os/tutorials/project-nrf52-slinky.md | 1 + docs/os/tutorials/project-stm32-slinky.md | 1 + docs/os/tutorials/rbnano2.md | 3 +- mkdocs.yml | 3 - 10 files changed, 80 insertions(+), 54 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/get_started/cross_tools.md ---------------------------------------------------------------------- diff --git a/docs/os/get_started/cross_tools.md b/docs/os/get_started/cross_tools.md index b68c1e9..450952d 100644 --- a/docs/os/get_started/cross_tools.md +++ b/docs/os/get_started/cross_tools.md @@ -1,14 +1,15 @@ # Installing Cross Tools for ARM -This page shows how to install tools on your laptop/computer to use for direct communication (e.g. for debugging) with some ARM based HW platforms running Apache Mynewt. You will also have to use the Newt tool installed to run natively on your machine. You may choose to do this instead of using the build toolchain and Newt tool available in a Docker container. +This page shows how to install tools on your laptop/computer to use for direct communication (e.g. for debugging) with some ARM based HW platforms running Apache Mynewt. It shows you how to install the following tools for Mac OS X and Linux: -This page provides guidance for installing the tools directly on your MAC and Linux machine. See the relevant sections below. +* ARM Cross toolchain +* Debugger to load and debug your device <br> -## Install ARM Cross tools in Mac OS X +## Install ARM Cross Toolchain -### Install Tool Chain +### Install ARM Toolchain For Mac OS X Install the PX4 Toolchain and check the version installed. ARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM @@ -34,27 +35,7 @@ including the latest releases. However, at present we have tested only with this version and recommend it for getting started. <br> - -### Install OpenOCD - -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](http://openocd.org). - -```no-highlight -$ brew install open-ocd -$ which openocd -/usr/local/bin/openocd -$ ls -l $(which openocd) -lrwxr-xr-x 1 <user> admin 36 Sep 17 16:22 /usr/local/bin/openocd -> ../Cellar/open-ocd/0.9.0/bin/openocd -``` - -<br> - -## Install ARM cross arm tools for Linux - -### Install Tool Chain +### Install 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 @@ -67,21 +48,79 @@ $ sudo apt-get update $ sudo apt-get install gcc-arm-none-eabi $ sudo apt-get install gdb-arm-none-eabi ``` +<br> +## Install Debugger +Mynewt uses, depending on the board, either the OpenOCD or SEGGER J-Link debugger. <br> -###Install OpenOCD +### Install OpenOCD 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](http://openocd.org). -If you are running Ubuntu 15.x, then you are in luck and you can simply run: +OpenOCD version 0.10.0-dev-snapshot that is currently in development is required. A binary for this version is available to download for Mac OS and Linux + +#### Install OpenOCD on Mac OS +Step 1: Download the [binary tarball for Mac OS](https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-89bf96ffe6ac66c80407af8383b9d5adc0dc35f4-MacOS.tgz). + +Step 2: Change to the root directory: +```no-highlight +$cd / +``` +Step 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. ```no-highlight -$ sudo apt-get install openocd +sudo tar -xf ~/Downloads/openocd-bin-8*-MacOS.tgz ` ``` - For this project, you should download the openocd 0.8.0 package from -[https://launchpad.net/ubuntu/vivid/+source/openocd](https://launchpad.net/ubuntu/vivid/+source/openocd). -The direct link to the amd64 build is -[http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb](http://launchpadlibrarian.net/188260097/openocd_0.8.0-4_amd64.deb). +Step 4: Check the OpenOCD version you are using: + +```no-highlight +$which openocd +/usr/local/bin/openocd +$openocd -v +Open On-Chip Debugger 0.10.0-dev-snapshot (2017-04-04-14:18) +Licensed under GNU GPL v2 +For bug reports, read +http://openocd.org/doc/doxygen/bugs.html +``` +#### Install OpenOCD on Linux + +Step 1: Download the [binary tarball for Linux 64 bits](https://github.com/runtimeco/openocd-binaries/raw/master/openocd-bin-89bf96ffe6ac66c80407af8383b9d5adc0dc35f4-Linux.tgz). + +Step 2: Change to the root directory: +``` +$cd / +``` + +Step 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. + +```no-highlight +$sudo tar --no-same-owner -xpf ~/Downloads/openocd-bin-8*-Linux.tgz +``` + +Step 4: Check the OpenOCD version you are using: + +```no-highlight +$which openocd +/usr/local/bin/openocd +$openocd -v +Open On-Chip Debugger 0.10.0-dev-snapshot (2017-04-04-14:18) +Licensed under GNU GPL v2 +For bug reports, read +http://openocd.org/doc/doxygen/bugs.html +``` +You should see version: ** 0.10.0-dev-snapshot (2017-04-04-14:18) **. + +If you see the following error message: + +** openocd: error while loading shared libraries: libftdi.so.1: cannot open shared object file: No such file or directory ** + +run the following to install the library: +```no-highlight +$sudo apt-get install libftdi1 +``` +<br> +###Install SEGGAR J-Link +You can download and install Segger J-LINK Software and documentation pack from [SEGGER](https://www.segger.com/jlink-software.html). http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/arduino_zero.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/arduino_zero.md b/docs/os/tutorials/arduino_zero.md index dc72b5b..68499b3 100644 --- a/docs/os/tutorials/arduino_zero.md +++ b/docs/os/tutorials/arduino_zero.md @@ -6,6 +6,7 @@ This tutorial shows you how to create, build and run the Blinky application on a * Meet the prerequisites listed in [Project Blinky](/os/tutorials/blinky.md). * Have an Arduino Zero board. Note: There are many flavors of Arduino. Make sure you are using an Arduino Zero. See below for the versions of Arduino Zero that are compatible with this tutorial. +* Install the [OpenOCD debugger](/os/get_started/cross_tools/). This tutorial uses the Arduino Zero Pro board. The tutorial has been tested on the following three Arduino Zero boards - Zero, M0 Pro, and Zero-Pro. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/blinky.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/blinky.md b/docs/os/tutorials/blinky.md index 59d9ad1..a411e1e 100644 --- a/docs/os/tutorials/blinky.md +++ b/docs/os/tutorials/blinky.md @@ -23,7 +23,6 @@ Ensure that you meet the following prerequisites before continuing with one of t * Have a computer to build a Mynewt application and connect to the board over USB. * Have a Micro-USB cable to connect the board and the computer. * Install the Newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). -* Install either the Jlink or OpenOCD debugger. * Create a project space (directory structure) and populate it with the core code repository (apache-mynewt-core) or know how to as explained in [Creating Your First Project](/os/get_started/project_create). * Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section. <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/blinky_primo.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/blinky_primo.md b/docs/os/tutorials/blinky_primo.md index 1193938..4eaf92d 100644 --- a/docs/os/tutorials/blinky_primo.md +++ b/docs/os/tutorials/blinky_primo.md @@ -8,7 +8,7 @@ Note that the Mynewt OS will run on the nRF52 chip in the Arduino Primo board. H * Meet the the prerequisites listed in [Project Blinky](/os/tutorials/blinky.md). * Have an Arduino Primo board. -* Install a debugger choose one of the two options below: Option 1 requires additional hardware but very easy to set up. +* Install a debugger. Choose one of the two options below: Option 1 requires additional hardware but very easy to set up. <br> ##### Option 1 @@ -17,21 +17,7 @@ Note that the Mynewt OS will run on the nRF52 chip in the Arduino Primo board. H * Install the [Segger JLINK Software and documentation pack](https://www.segger.com/jlink-software.html). ##### Option 2 -No additional hardware is required but a version of OpenOCD 0.10.0 that is currently in development needs to be installed. A patch for the nRF52 has been applied to the OpenOCD code in development and a tarball has been made available for download [here](downloads/openocd-wnrf52.tgz). Untar it. From the top of the directory tree ("openocd-code-89bf96ffe6ac66c80407af8383b9d5adc0dc35f4"), build it using the following configuration: - -``` -$./configure --enable-cmsis-dap --enable-openjtag_ftdi --enable-jlink --enable-stlink -``` - -Then run `make` and `sudo make install`. This step takes minutes, so be patient. - -``` -$ openocd -v -Open On-Chip Debugger 0.10.0-dev-snapshot (2016-05-20-10:43) -Licensed under GNU GPL v2 -For bug reports, read - http://openocd.org/doc/doxygen/bugs.html -``` +This board requires a patch version of OpenOCD 0.10.0 that is in development. See [Install OpenOCD](/os/get_started/cross_tools.md) instructions to install it if you do not have this version installed. You can now use openocd to upload to Arduino Primo board via the USB port itself. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/nRF52.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/nRF52.md b/docs/os/tutorials/nRF52.md index c62f85e..deca009 100644 --- a/docs/os/tutorials/nRF52.md +++ b/docs/os/tutorials/nRF52.md @@ -12,6 +12,7 @@ Note that there are several versions of the nRF52 in the market. The boards test * Have a nRF52 Development Kit (one of the following) * Dev Kit from Nordic - PCA 10040 * Eval Kit from Rigado - BMD-300-EVAL-ES +* Install the [Segger JLINK Software and documentation pack](https://www.segger.com/jlink-software.html). This tutorial uses the Nordic nRF52-DK board. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/olimex.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/olimex.md b/docs/os/tutorials/olimex.md index 44e8b92..0233b59 100644 --- a/docs/os/tutorials/olimex.md +++ b/docs/os/tutorials/olimex.md @@ -8,6 +8,8 @@ This tutorial shows you how to create, build, and run the Blinky application on * Have a STM32-E407 development board from Olimex. * Have a ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board) * Have a USB A-B type cable to connect the debugger to your computer. +* Install the [OpenOCD debugger](/os/get_started/cross_tools/). + <br> ### Create a Project Create a new project if you do not have an existing one. You can skip this step and proceed to [create the targets](#create_targets) if you already created a project. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/project-nrf52-slinky.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/project-nrf52-slinky.md b/docs/os/tutorials/project-nrf52-slinky.md index dfc4c57..729d32a 100644 --- a/docs/os/tutorials/project-nrf52-slinky.md +++ b/docs/os/tutorials/project-nrf52-slinky.md @@ -4,6 +4,7 @@ This tutorial shows you how to create, build and run the Slinky application and ### Prerequisites * Meet the prerequisites listed in [Project Slinky](/os/tutorials/project-slinky.md). * Have a Nordic nRF52-DK board. +* Install the [Segger JLINK Software and documentation pack](https://www.segger.com/jlink-software.html). ### Create a New Project Create a new project if you do not have an existing one. You can skip this step and proceed to [create the targets](#create_targets) if you already have a project created or completed the [Sim Slinky](project-slinky.md) tutorial. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/project-stm32-slinky.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/project-stm32-slinky.md b/docs/os/tutorials/project-stm32-slinky.md index 6ee5f3b..16387c5 100644 --- a/docs/os/tutorials/project-stm32-slinky.md +++ b/docs/os/tutorials/project-stm32-slinky.md @@ -8,6 +8,7 @@ This tutorial shows you how to create, build and run the Slinky application and * Have a ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board) * Have a USB A-B type cable to connect the debugger to your computer. * Have a USB to TTL Serial Cable with female wiring harness. +* Install the [OpenOCD debugger](/os/get_started/cross_tools/). ### Create a New Project Create a new project if you do not have an existing one. You can skip this step and proceed to [create the targets](#create_targets) if you already have a project created or completed the [Sim Slinky](project-slinky.md) tutorial. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/docs/os/tutorials/rbnano2.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/rbnano2.md b/docs/os/tutorials/rbnano2.md index ea0d3ad..4f93c09 100644 --- a/docs/os/tutorials/rbnano2.md +++ b/docs/os/tutorials/rbnano2.md @@ -7,8 +7,7 @@ This tutorial shows you how to create, build and run the Blinky application on a * Meet the prerequisites listed in [Project Blinky](/os/tutorials/blinky.md). * Have a RedBear Nano 2 board. - -**Note:** You must install a patched version of OpenOCD .10.0 (See [Debugger Option 2 in the Arduino Primo Blinky Tutorial](/os/tutorials/blinky_primo)). +* Install a patched version of OpenOCD 0.10.0 described in [Install OpenOCD](os/get_started/cross_tools/). ### Create a Project Create a new project if you do not have an existing one. You can skip this step and proceed to [create the targets](#create_targets) if you already have a project created. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/0c750d32/mkdocs.yml ---------------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index 61d89cf..8d51e74 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,9 +33,6 @@ pages: - 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md' - 'Blinky on Arduino Primo': 'os/tutorials/blinky_primo.md' - 'Blinky on Olimex': 'os/tutorials/olimex.md' - - 'Blinky on STM32F303': - - toc: 'os/tutorials/STM32F303.md' - - 'Pinwheel Blinky': 'os/tutorials/pin-wheel-mods.md' - 'Blinky on nRF52': 'os/tutorials/nRF52.md' - 'Blinky on RedBear Nano 2': 'os/tutorials/rbnano2.md' - 'Add Console and Shell to Blinky': 'os/tutorials/blinky_console.md'
