You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/01/06 22:56:26 UTC
[23/45] incubator-mynewt-site git commit: fixed anchors in project
Blinky - still need to update Windows instructions for hardware target
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/project1.md
----------------------------------------------------------------------
diff --git a/docs/get_started/project1.md b/docs/get_started/project1.md
new file mode 100644
index 0000000..3be7e26
--- /dev/null
+++ b/docs/get_started/project1.md
@@ -0,0 +1,1062 @@
+## Blinky, the First Project
+
+### Objective
+
+We will show you how you can use eggs from a nest on Mynewt to make an LED on a target board blink. We will call it ** Project Blinky**. The goals of this tutorial are threefold:
+
+1. First, you will learn how to set up your environment to be ready to use Mynewt OS and newt tool.
+2. Second, we will walk you through a download of eggs for building and testing [on a simulated target](#building-test-code-on-simulator).
+3. Third, you will download eggs and use tools to create a runtime image for a board to make its LED blink. You have two choices here - you can [download an image to SRAM](#using-sram-to-make-led-blink) or you can [download it to flash](#using-flash-to-make-led-blink).
+
+** Time Requirement**: Allow yourself a couple of hours for this project if you are relatively new to embedded systems and playing with development boards. Those jumpers can be pesky!
+
+
+### What you need
+
+1. STM32-E407 development board from Olimex. You can order it from [http://www.mouser.com](http://www.mouser.com/ProductDetail/Olimex-Ltd/STM32-E407/?qs=UN6GZl1KCcit6Ye0xmPO4A%3D%3D), [http://www.digikey.com](http://www.digikey.com/product-detail/en/STM32-E407/1188-1093-ND/3726951), and other places.
+2. ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)
+3. USB A-B type cable to connect the debugger to your personal computer
+4. Personal Computer
+
+The instructions assume the user is using a Bourne-compatible shell (e.g. bash or zsh) on your computer. The given instructions have been tested with the following releases of operating systems:
+
+* Mac: OS X Yosemite Version 10.10.5
+* Linux: Ubuntu 14.10 (Utopic Unicorn)
+* Windows: Windows 10
+
+
+### Access to the Apache repo
+
+* Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.
+
+* The latest codebase for the Mynewt OS is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* The latest codebase for the Newt tool is on the master branch at https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git
+
+The following shows how to clone a Mynewt OS code repository:
+
+* Non Committers
+
+ $ git clone http://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+* Committers
+
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git
+
+
+
+### Getting your Mac Ready
+
+#### Installing Homebrew to ease installs on OS X
+
+* Do you have Homebrew? If not, open a terminal on your Mac and paste the following at a Terminal prompt. It will ask you for your sudo password.
+
+ $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+ Alternatively, you can just extract (or `git clone`) Homebrew and install it to `/usr/local`.
+
+#### Installing Go
+
+* The directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.
+
+ $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=`pwd`
+
+ Note that you need to add export statements to ~/.bash_profile to export variables permanently. Don't forget to source the file for the change to go into effect.
+
+ $ vi ~/.bash_profile
+ $ source ~/.bash_profile
+
+* Next you will use Homebrew to install Go. The summary message at the end of the installation should indicate that it is installed in the /usr/local/Cellar/go/ directory. You will use the Go command 'install' to compile and install packages (called eggs in the Mynewt world) and dependencies.
+
+ $ brew install go
+ ==>
+ ...
+ ...
+ ==> *Summary*
+ 🍺 /usr/local/Cellar/go/1.5.1: 5330 files, 273M
+
+ Alternatively, you can download the Go package directly from (https://golang.org/dl/) instead of brewing it. Install it in /usr/local directory.
+
+
+#### Creating local repository
+
+* You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.
+
+ $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ ls
+ bin pkg src
+ $ ls src
+ git-wip-us.apache.org github.com gopkg.in
+
+
+* Check that newt.go is in place.
+
+ $ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+
+
+#### Building the Newt tool
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
+
+* Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.
+
+ Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your .bash_profile and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable. Don't forget to reload the updated bash profile by typing `source ~/.bash_profile` at the prompt!
+
+ $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -h, --help=false: help for newt
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
+
+ Use "newt help [command]" for more information about a command.
+
+* Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool.
+
+#### Getting the debugger ready
+
+* Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. So, first install gcc. You will see the brew steps and a final summary confirming install.
+
+ $ brew install gcc
+ ...
+ ...
+ ==> Summary
+ 🍺 /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M
+
+
+* ARM maintains a pre-built GNU toolchain with a GCC source branch targeted at Embedded ARM Processors namely Cortex-R/Cortex-M processor families. Install the PX4 Toolchain and check the version installed. Make sure that the symbolic link installed by Homebrew points to the correct version of the debugger. If not, you can either change the symbolic link using the "ln -f -s" command or just go ahead and try with the version it points to!
+
+ $ 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. MynewtOS will eventually work with multiple versions available including the latest releases. However, at present we have tested only with this version and recommend it for getting started.
+
+* You have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. Use brew to install it. Brew adds a simlink /usr/local/bin/openocd to the openocd directory in the Cellar. For more on OpenOCD go to [http://openocd.org](http://openocd.org).
+
+ $ 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
+
+* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
+
+
+### Getting your Ubuntu machine Ready
+
+
+#### Installing some prerequisites
+
+* Install git, libcurl, and the Go language if you do not have them already.
+
+ $ sudo apt-get install git
+ $ sudo apt-get install libcurl4-gnutls-dev
+ $ sudo apt-get install golang
+
+#### Creating local repository
+
+* The directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory where you will soon clone the newt tool repository.
+
+ $ cd $HOME
+ $ mkdir -p dev/go
+ $ cd dev/go
+ $ export GOPATH=$PWD
+
+ Note that you need to add export statements to ~/.bashrc (or equivalent) to export variables permanently.
+
+* You are ready to download the newt tool repository. You will use Go to copy the directory (currently the asf incubator directory). Be patient as it may take a minute or two. Check the directories installed.
+
+ $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ ls
+ bin pkg src
+ $ ls src
+ git-wip-us.apache.org github.com gopkg.in
+
+
+* Check that newt is in place.
+
+ $ ls $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+
+#### Building the newt tool
+
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ cd $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
+
+* Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.
+
+ Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to store the command in a variable in your .bash_profile. So type in `export newt="go run $GOPATH/src/git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt/newt/go"` in your ~/.bashrc (or equivalent) and execute it by calling `$newt` at the prompt instead of `newt`. Here, you use `go run` which runs the compiled binary directly without producing an executable.
+
+
+ $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -h, --help=false: help for newt
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
+
+ Use "newt help [command]" for more information about a command.
+
+* Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool.
+
+#### Getting the debugger ready
+
+* Before you start building nests and hatching eggs, you need to do one final step in the environment preparation - install gcc / libc that can produce 32-bit executables. You can install these as follows:
+
+ $ sudo apt-get install gcc-multilib libc6-i386
+
+* For the LED project on the Olimex hardware, you have to install gcc for AM 4.9.3. This package can be installed with apt-get as documented below. The steps are explained in depth at [https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded](https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded).
+
+ $ sudo apt-get remove binutils-arm-none-eabi gcc-arm-none-eabi
+ $ sudo add-apt-repository ppa:terry.guo/gcc-arm-embedded
+ $ sudo apt-get update
+ $ sudo apt-get install gcc-arm-none-eabi
+
+* And finally, you have to install OpenOCD (Open On-Chip Debugger) which is an open-source software that will allow you to interface with the JTAG debug connector/adaptor for the Olimex board. It lets you program, debug, and test embedded target devices which, in this case, is the Olimex board. You have to acquire OpenOCD 0.8.0.
+
+ If you are running Ubuntu 15.x, then you are in luck and you can simply run:
+
+ $ sudo apt-get install openocd
+
+ Other versions of Ubuntu may not have the correct version of openocd available. In this case, 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).
+
+* Proceed to the [Building test code on simulator](#building-test-code-on-simulator) section.
+
+### Getting your Windows machine ready for simulated target
+
+The `newt` tool is the build software used to build Mynewt OS images or executables for any embedded hardware device/board, including the one for the current tutorial (STM32-E407 development board from Olimex). You can run the `newt` tool natively on a computer running any of the three Operating System machines - OSX, Linux, or Windows.
+
+However, Mynewt OS images for a simulated target are built on the Windows machine by using Linux versions of the build software (newt)in a virtual machine on your Windows box. The Linux VM is set up by installing the Docker Toolbox. Your Windows machine will communicate with the Linux VM via transient ssh connections. You will then download a Docker image (`newtvm.exe`)that allows you to run the newt commands in the Linux Docker instance. The Docker image contains:
+
+ * The newt command-line tool
+ * Go
+ * A multilib-capable native gcc / glibc
+ * An arm-none-eabi gcc
+ * Native gdb
+
+ The sequence of events when using the Docker image is as follows:
+
+ 1. A new docker environment is created in the Linux VM.
+ 2. The specified command with the newtvm prefix (`newtvm newt` command) is sent to the docker environment via ssh.
+ 3. The Linux command runs.
+ 4. The output from the command is sent back to Windows via ssh.
+ 5. The output is displayed in the Windows command prompt.
+
+
+#### Install Linux virtual machine
+
+* Download the Docker Toolbox for Windows (version 1.9.0c or later) from [https://www.docker.com/docker-toolbox](https://www.docker.com/docker-toolbox). The Docker toolbox creates a consistently reproducible and self-contained environment in Linux.
+
+* Run the Docker Toolbox installer. All the default settings are OK.
+
+* You may need to add "C:\Program Files\Git\usr\bin" to your PATH
+environment variable. To add to the PATH environment variable, right-click on the Start button in the bottom left corner. Choose System -> Advanced system settings -> Environment Variables. Click on the PATH variable under "System variables" and click Edit to check and add it if it is not already there.
+
+#### Install newtvm tool
+
+* From your base user (home) directory, pull or clone the latest code from the newt repository into the `newt` directory. It includes the executable `newtvm.exe` for the newtvm tool in the `newtvm` directory.
+
+ C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt newt
+
+ The newtvm tool is what allows you to run programs in the Linux docker
+instance.
+
+* Run the Docker Quickstart Terminal application inside the Docker folder under Programs. You can find it by clicking Start button -> All apps. By default, the Docker Toolbox installer creates a shortcut to this program on your desktop. Wait until you see an ASCII art whale displayed in the terminal window and the Docker prompt given.
+
+
+
+ ## .
+ ## ## ## ==
+ ## ## ## ## ## ===
+ /"""""""""""""""""\___/ ===
+ ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
+ \______ o __/
+ \ \ __/
+ \____\_______/
+
+ docker is configured to use the default machine with IP 192.168.99.100
+ For help getting started, check out the docs at https://docs.docker.com
+
+ admin@dev1 MINGW64 ~ (master)
+ $
+
+ The first time you run this, it may take several minutes to complete. You will need to run the Docker Quickstart Terminal once each time you
+restart your computer.
+
+* Open a command prompt (e.g., Windows-R, "cmd", enter). You execute the newt tool commands as though you were running newt in Linux, but you prefix each command with "newtvm". For example:
+
+ C:\Users\admin\newt\newtvm> newtvm newt help
+
+
+ The newtvm tool will take a long time to run the first time you execute
+it. The delay is due to the fact that the tool must download the mynewt
+docker instance.
+
+* You are now ready to proceed to [building the image for the simulated target](#building-test-code-on-simulator).
+
+
+### Getting your Windows machine ready for hardware target
+
+When you want to produce images for actual hardware board on your Windows machine, go through the following setup procedure and then proceed to the [blinky project on the Olimex board](#Using-SRAM-to-make-LED-blink) with this method.
+
+#### Installing some prerequisites
+
+* You have to install the following if you do not have them already. The steps below indicate specific folders where each of these programs should be installed. You can choose different locations, but the remainder of this
+tutorial for a Windows machine assumes the specified folders.
+
+ * win-builds-i686
+ * win-builds-x86_64
+ * MSYS
+ * gcc for ARM
+ * openocd
+ * zadig
+ * git
+ * go
+
+ - *win-builds (mingw64) 1.5 for i686*
+
+ Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at: "C:\win-builds-i686".
+
+ Be sure to click the i686 option (not x86_64). The defaults for all other options are OK. The installer will want to download a bunch of additional packages. They are not all necessary, but it is simplest to just accept the defaults.
+
+ - *win-builds (mingw64) 1.5 for x86_64*
+
+ Download from [http://win-builds.org/doku.php/download_and_installation_from_windows](http://win-builds.org/doku.php/download_and_installation_from_windows). Install at "C:\win-builds-x86_64"
+
+ Run the installer a second time, but this time click the x86_64 option, NOT i686. The defaults for all other options are OK.
+
+ - *MSYS*
+
+ Start your download from [http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip](http://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip)
+
+ Unzip to "C:\msys"
+
+ - *gcc for ARM, 4.9.3*
+
+ Download the Windows installer from [https://launchpad.net/gcc-arm-embedded/+download](https://launchpad.net/gcc-arm-embedded/+download) and install at "C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3".
+
+ - OpenOCD 0.8.0
+
+ Download OpenOCD 0.8.0 from [http://www.freddiechopin.info/en/download/category/4-openocd](http://www.freddiechopin.info/en/download/category/4-openocd). Unzip to "C:\openocd".
+
+ - Zadig 2.1.2
+
+ Download it from [http://zadig.akeo.ie](http://zadig.akeo.ie) and install it at "C:\zadig".
+
+ - Git
+
+ Click on [https://git-scm.com/download/win](https://git-scm.com/download/win) to start the download. Install at "C:\Program Files (x86)\Git". Specify the "Use Git from the Windows Command Prompt" option. The defaults for all other options are OK.
+
+ - Go
+
+ Download the release for Microsoft Windows from [https://golang.org/dl/](https://golang.org/dl/) and install it "C:\Go".
+
+
+#### Creating local repository
+
+* The directory structure must be first readied for using Go. Go code must be kept inside a workspace. A workspace is a directory hierarchy with three directories at its root:
+
+ * src contains Go source files organized into packages (one package per directory),
+
+ * pkg contains package objects, and
+
+ * bin contains executable commands.
+
+ The GOPATH environment variable specifies the location of your workspace. First create a 'dev' directory and then a 'go' directory under it. Set the GOPATH environment variable to this directory and then proceed to create the directory for cloning the newt tool repository.
+
+ $ cd c:\
+ $ mkdir dev\go
+ $ cd dev\go
+
+* Set the following user environment variables using the steps outlined here.
+
+ * GOPATH: C:\dev\go
+ * PATH: C:\Program Files (x86)\GNU Tools ARM Embedded\4.9 2015q3\bin;%GOPATH%\bin;C:\win-builds-x86_64\bin;C:\win-builds-i686\bin;C:\msys\bin
+
+ Steps:
+
+ 1. Right-click the start button
+ 2. Click "Control panel"
+ 3. Click "System and Security"
+ 4. Click "System"
+ 5. Click "Advanced system settings" in the left panel
+ 6. Click the "Envoronment Variables..." button
+ 7. There will be two sets of environment variables: user variables
+ in the upper half of the screen, and system variables in the lower
+ half. Configuring the user variables is recommended and tested
+ (though system variables will work as well).
+
+
+* Next, install godep. Note that the following command produces no output.
+
+ $ go get github.com/tools/godep
+
+* Set up the repository for the package building tool "newt" on your local machine. First create the appropriate directory for it and then clone the newt tool repository from the online apache repository (or its github.com mirror) into this newly created directory. Check the contents of the directory.
+
+ $ go get git-wip-us.apache.org/repos/asf/incubator-mynewt-newt.git/newt
+ $ dir
+ bin pkg src
+ $ dir src
+ git-wip-us.apache.org github.com gopkg.in
+ $ dir
+ newt
+ $ cd newt
+ $ dir
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+
+* Check that newt is in place.
+
+ $ dir $GOPATH\src\git-wip-us.apache.org\repos\asf\incubator-mynewt-newt.git\newt
+ Godeps README.md coding_style.txt newt.go
+ LICENSE cli design.txt
+
+
+
+#### Building the newt tool
+
+* You will use Go to run the newt.go program to build the newt tool. The command used is `go install` which compiles and writes the resulting executable to an output file named `newt`. It installs the results along with its dependencies in $GOPATH/bin.
+
+ $ go install
+ $ ls "$GOPATH"/bin/
+ godep incubator-mynewt-newt.git newt
+
+* Try running newt using the compiled binary. For example, check for the version number by typing 'newt version'. See all the possible commands available to a user of newt by typing 'newt -h'.
+
+ Note: If you are going to be be modifying the newt tool itself often and wish to compile the program every time you call it, you may want to define the newt environment variable that allows you to execute the command via `%newt%`. Use `set newt=go run %GOPATH%\src\github.com\mynewt\newt\newt.go` or set it from the GUI. Here, you use `go run` which runs the compiled binary directly without producing an executable.
+
+ $ newt version
+ Newt version: 1.0
+ $ newt -h
+ Newt allows you to create your own embedded project based on the Mynewt
+ operating system. Newt provides both build and package management in a
+ single tool, which allows you to compose an embedded workspace, and set
+ of projects, and then build the necessary artifacts from those projects.
+ For more information on the Mynewt operating system, please visit
+ https://www.github.com/mynewt/documentation.
+
+ Please use the newt help command, and specify the name of the command
+ you want help for, for help on how to use a specific command
+
+ Usage:
+ newt [flags]
+ newt [command]
+
+ Examples:
+ newt
+ newt help [<command-name>]
+ For help on <command-name>. If not specified, print this message.
+
+
+ Available Commands:
+ version Display the Newt version number.
+ target Set and view target information
+ egg Commands to list and inspect eggs on a nest
+ nest Commands to manage nests & clutches (remote egg repositories)
+ help Help about any command
+
+ Flags:
+ -h, --help=false: help for newt
+ -l, --loglevel="WARN": Log level, defaults to WARN.
+ -q, --quiet=false: Be quiet; only display error output.
+ -s, --silent=false: Be silent; don't output anything.
+ -v, --verbose=false: Enable verbose output when executing commands.
+
+
+ Use "newt help [command]" for more information about a command.
+
+* Without creating a project repository you can't do a whole lot with the Newt tool. So you'll have to wait till you have downloaded a nest to try out the tool.
+
+#### Getting the debugger ready
+
+* Use Zadig to configure the USB driver for your Olimex debugger. If your debugger is already set up, you can skip this step.
+
+ 1. Plug in your Olimex debugger.
+ 2. Start Zadig.
+ 3. Check the Options -> List All Devices checkbox.
+ 4. Select "Olimex OpenOCD JTAG ARM-USB-TINY-H" in the dropdown menu.
+ 5. Select the "WinUSB" driver.
+ 6. Click the "Install Driver" button.
+
+* Proceed to the section on how to [make an LED blink](#using-sram-to-make-led-blink) section.
+
+
+### Building test code on simulator
+
+Note: On a Windows computer, the simulator can be run only in a Linux virtual environment. Make sure you have installed the Docker instance as outlined in [an earlier section](#getting-your-windows-machine-ready-for-simulated-target). Consequently, all `newt` commands must be prefaced with `newtvm`.
+
+1. First, you have to create a repository for the project i.e. build your first nest! Go to ~/dev (or your base user directory on a Windows machine)and clone the larva repository from the apache git repository into a local directory named `larva`.
+
+ Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.
+
+
+ $ cd ~/dev
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ $ ls
+ go larva
+ $ cd larva
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
+
+ On Windows, open a command prompt (e.g., Windows-R, "cmd", enter) and work from your home directory:
+
+ C:\Users\admin> git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ C:\Users\admin> cd larva
+ C:\Users\admin\larva> dir
+ Volume in drive C is Windows
+ Volume Serial Number is 4CBB-0920
+
+ Directory of C:\Users\admin\larva
+
+ <DIR> .
+ <DIR> ..
+ 76 .gitignore
+ 0 .gitmodules
+ .nest
+ 6,133 clutch.yml
+ <DIR> compiler
+ <DIR> hw
+ <DIR> libs
+ 11,560 LICENSE
+ 20 nest.yml
+ <DIR> net
+ <DIR> project
+ 2,263 README.md
+ <DIR> scripts
+ 6 File(s) 20,052 bytes
+ 9 Dir(s) 90,723,442,688 bytes free
+
+2. You will now create a new target using the newt tool. You can either use the compiled binary `newt` or run the newt.go program using `$newt` (assuming you have stored the command in a variable in your .bash_profile or .bashrc). When you do a `newt target show` or `$newt target show` it should list all the projects you have created so far.
+
+ $ newt target create sim_test
+ Creating target sim_test
+ Target sim_test sucessfully created!
+ $ newt target show
+ sim_test
+ name: sim_test
+ arch: sim
+
+ Remember, on a Windows machine you will have to preface `newt` with `newtvm`!
+
+ C:\Users\admin\larva>newtvm newt target create sim_test
+
+3. Now continue to populate and build out the sim project.
+
+ $ newt target set sim_test project=test
+ Target sim_test successfully set project to test
+ $ newt target set sim_test compiler_def=debug
+ Target sim_test successfully set compiler_def to debug
+ $ newt target set sim_test bsp=hw/bsp/native
+ Target sim_test successfully set bsp to hw/bsp/native
+ $ newt target set sim_test compiler=sim
+ Target sim_test successfully set compiler to sim
+ $ newt target show sim_test
+ sim_test
+ arch: sim
+ project: test
+ compiler_def: debug
+ bsp: hw/bsp/native
+ compiler: sim
+ name: sim_test
+
+ Again remember to preface `newt` with `newtvm`on a Windows machine as shown below. Continue to fill out all the project attributes.
+
+ C:\Users\admin\larva>newtvm newt target set sim_test project=test
+ Target sim_test successfully set project to test
+
+4. Configure newt to use the gnu build tools native to OS X or linux. In order for sim to work properly, it needs to be using 32-bit gcc (gcc-5). Replace
+~/dev/larva/compiler/sim/compiler.yml with the compiler/sim/osx-compiler.yml or linux-compiler.yml file, depending on the system. On a Windows machine follow the instruction for the Linux machine as you are running commands in a Linux VM.
+
+ For a Mac OS X environment:
+
+ $ cp compiler/sim/osx-compiler.yml compiler/sim/compiler.yml
+
+ For a Linux machine:
+
+ $ cp compiler/sim/linux-compiler.yml compiler/sim/compiler.yml
+
+5. Next, create (hatch!) the eggs for this project using the newt tool - basically, build the packages for it. You can specify the VERBOSE option if you want to see the gory details. Always remember to preface `newt` with `newtvm`on a Windows machine.
+
+ $ newt target build sim_test
+ Successfully run!
+
+ You can specify the VERBOSE option if you want to see the gory details.
+
+ $newt -l VERBOSE target build sim_test
+ 2015/09/29 09:46:12 [INFO] Building project test
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//bootutil...
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//cmsis-core...
+ 2015/09/29 09:46:12 [INFO] Loading Package /Users/aditihilbert/dev/larva/libs//ffs..
+ ...
+ Successfully run!
+
+6. Try running the test suite executable inside this project and enjoy your first successful hatch.
+
+ $ newt ./project/test/bin/sim_test/test.elf
+ [pass] os_mempool_test_suite/os_mempool_test_case
+ [pass] os_mutex_test_suite/os_mutex_test_basic
+ [pass] os_mutex_test_suite/os_mutex_test_case_1
+ [pass] os_mutex_test_suite/os_mutex_test_case_2
+ [pass] os_sem_test_suite/os_sem_test_basic
+ [pass] os_sem_test_suite/os_sem_test_case_1
+ [pass] os_sem_test_suite/os_sem_test_case_2
+ [pass] os_sem_test_suite/os_sem_test_case_3
+ [pass] os_sem_test_suite/os_sem_test_case_4
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_1
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_2
+ [pass] os_mbuf_test_suite/os_mbuf_test_case_3
+ [pass] gen_1_1/ffs_test_unlink
+ [pass] gen_1_1/ffs_test_rename
+ [pass] gen_1_1/ffs_test_truncate
+ [pass] gen_1_1/ffs_test_append
+ [pass] gen_1_1/ffs_test_read
+ [pass] gen_1_1/ffs_test_overwrite_one
+ [pass] gen_1_1/ffs_test_overwrite_two
+ [pass] gen_1_1/ffs_test_overwrite_three
+ ...
+ ...
+ [pass] boot_test_main/boot_test_vb_ns_11
+
+
+### Using SRAM to make LED blink
+
+You are here because you want to build an image to be run from internal SRAM on the Olimex board.
+
+#### Preparing the Software
+
+1. Make sure the PATH environment variable includes the $HOME/dev/go/bin directory (or C:\%GOPATH%\bin on Windows machine).
+
+ Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows (e.g. `cd dev\go` instead of `cd dev/go`). The newt tool commands do not change.
+
+
+2. If you have cloned the larva repository for the simulator test in the previous section you can skip this step. Otherwise, you have to create a repository for the project i.e. build your first nest! Go to ~/dev and clone the larva repository from the apache git repository into a local directory named `larva`.
+
+ Substitute DOS commands for Unix commands as necessary in the following steps if your machine is running Windows. The newt tool commands do not change.
+
+ $ cd ~/dev
+ $ git clone https://git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git larva
+ $ ls
+ go larva
+ $ cd larva
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
+
+3. You first have to create a repository for the project. Go to the ~dev/larva directory and build out a second project inside larva. The project name is "blinky", in keeping with the objective. Starting with the target name, you have to specify the different aspects of the project to pull the appropriate eggs and build the right package for the board. In this case that means setting the architecture (arch), compiler, board support package (bsp), project, and compiler mode.
+
+Remember to prefix each command with "newtvm" if you are executing the newt command in a Linux virtual machine on your Windows box!
+
+
+ $ newt target create blinky
+ Creating target blinky
+ Target blinky sucessfully created!
+ $ newt target set blinky arch=cortex_m4
+ Target blinky successfully set arch to arm
+ $ newt target set blinky compiler=arm-none-eabi-m4
+ Target blinky successfully set compiler to arm-none-eabi-m4
+ $ newt target set blinky project=blinky
+ Target blinky successfully set project to blinky
+ $ newt target set blinky compiler_def=debug
+ Target blinky successfully set compiler_def to debug
+ $ newt target set blinky bsp=hw/bsp/olimex_stm32-e407_devboard
+ Target blinky successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
+ $ newt target show blinky
+ blinky
+ compiler: arm-none-eabi-m4
+ project: blinky
+ compiler_def: debug
+ bsp: hw/bsp/olimex_stm32-e407_devboard
+ name: blinky
+ arch: cortex_m4
+
+4. Now you have to build the image. The linker script within the `hw/bsp/olimex_stm32-e407_devboard` egg builds an image for flash memory by default. Since you want an image for the SRAM, you need to switch that script with `run_from_sram.ld` in order to get the egg to produce an image for SRAM. <font color="red"> We are working on making it easier to specify where the executable will be run from for a particular project and automatically choose the correct linker scripts and generate the appropriate image. It will be specified as a project identity e.g. bootloader, RAM, flash (default) and the target will build accordingly. </font>.
+
+ Once the target is built, you can find the executable "blinky.elf" in the project directory at ~/dev/larva/project/blinky/bin/blinky. It's a good idea to take a little time to understand the directory structure.
+
+ $ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ $ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
+ $ cp run_from_sram.ld olimex_stm32-e407_devboard.ld
+ $ cd ~/dev/larva/project/blinky/bin/blinky
+ $ newt target build blinky
+ Building target blinky (project = blinky)
+ Compiling case.c
+ Compiling suite.c
+ ...
+ Successfully run!
+ $ ls
+ LICENSE clutch.yml hw nest.yml project
+ README.md compiler libs net scripts
+ $ cd project
+ $ ls
+ bin2img bletest blinky boot ffs2native test
+ $ cd blinky
+ $ ls
+ bin blinky.yml egg.yml src
+ $ cd bin
+ $ ls
+ blinky
+ $ cd blinky
+ $ ls
+ blinky.elf blinky.elf.bin blinky.elf.cmd blinky.elf.lst blinky.elf.map
+
+
+5. Check that you have all the scripts needed to get OpenOCD up and talking with the project's specific hardware. Depending on your system (Ubuntu, Windows) you may already have the scripts in your `/usr/share/openocd/scripts/ ` directory as they may have been part of the openocd download. If yes, you are all set and can proceed to preparing the hardware.
+
+ Otherwise check the `~/dev/larva/hw/bsp/olimex_stm32-e407_devboard` directory for a file named `f407.cfg`. That is the config we will use to talk to this specific hardware using OpenOCD. You are all set if you see it.
+
+ $ ls ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ bin olimex_stm32-e407_devboard_debug.sh
+ boot-olimex_stm32-e407_devboard.ld olimex_stm32-e407_devboard_download.sh
+ egg.yml run_from_flash.ld
+ f407.cfg run_from_loader.ld
+ include run_from_sram.ld
+ olimex_stm32-e407_devboard.ld src
+
+
+#### Preparing the hardware to boot from embedded SRAM
+
+1. Locate the boot jumpers on the board.
+
+
+
+2. B1_1/B1_0 and B0_1/B0_0 are PTH jumpers which can be moved relatively easy. Note that the markings on the board may not always be accurate. Always refer to the manual for the correct positioning of jumpers in case of doubt. The two jumpers must always be moved together – they are responsible for the boot mode if bootloader is present. The board can search for bootloader on three places – User Flash Memory, System Memory or the Embedded SRAM. We will configure it to boot from SRAM by jumpering B0_1 and B1_1.
+
+3. Connect USB-OTG#2 in the picture above to a USB port on your computer (or a powered USB hub to make sure there is enough power available to the board).
+
+4. The red PWR LED should be lit.
+
+5. Connect the JTAG connector to the SWD/JTAG interface on the board. The other end of the cable should be connected to the USB port or hub of your computer.
+
+
+
+#### Let's Go!
+
+1. Make sure you are in the blinky project directory with the blinky.elf executable. Run the debug command in the newt tool. You should see some status messages are shown below. There is an inbuilt `-c "reset halt"` flag that tells it to halt after opening the session.
+
+ $ cd dev/larva/project/blinky/bin/blinky
+ $ newt target debug blinky
+ Debugging with /Users/aditihilbert/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
+ Debugging /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word"...
+ Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/ blinky/blinky.elf...done.
+ Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
+ Licensed under GNU GPL v2
+ For bug reports, read
+ http://openocd.sourceforge.net/doc/doxygen/bugs.html
+ Info : only one transport option; autoselect 'jtag'
+ adapter speed: 1000 kHz
+ adapter_nsrst_delay: 100
+ jtag_ntrst_delay: 100
+ Warn : target name is deprecated use: 'cortex_m'
+ DEPRECATED! use 'cortex_m' not 'cortex_m3'
+ cortex_m reset_config sysresetreq
+ Info : clock speed 1000 kHz
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ target state: halted
+ target halted due to debug-request, current mode: Thread
+ xPSR: 0x01000000 pc: 0x20000250 msp: 0x10010000
+ Info : accepting 'gdb' connection from 3333
+ Info : device id = 0x10036413
+ Info : flash size = 1024kbytes
+ Reset_Handler () at startup_STM32F40x.s:199
+ 199 ldr r1, =__etext
+
+
+ Check the value of the msp (main service pointer) register. If it is not 0x10010000 as indicated above, you will have to manually set it after you open the gdp tool and load the image on it.
+
+ (gdb) set $msp=0x10010000
+
+ Now load the image and type "c" or "continue" from the GNU debugger.
+
+ (gdb) load ~/dev/larva/project/blinky/bin/blinky/blinky.elf
+ Loading section .text, size 0x4294 lma 0x20000000
+ Loading section .ARM.extab, size 0x24 lma 0x20004294
+ Loading section .ARM.exidx, size 0xd8 lma 0x200042b8
+ Loading section .data, size 0x874 lma 0x20004390
+ Start address 0x20000250, load size 19460
+ Transfer rate: 81 KB/sec, 2432 bytes/write.
+ (gdb) c
+ Continuing.
+
+2. Voilà! The board's LED should be blinking at 1 Hz.
+
+### Using flash to make LED blink
+
+You are here because you want to build an image to be run from flash memory on the Olimex board.
+
+1. Configure the board to boot from flash by moving the two jumpers together to B0_0 and B1_0. Refer to the pictures of the board under the section titled ["Preparing the hardware to boot from embedded SRAM"](#preparing-the-hardware-to-boot-from-embedded-sram).
+
+ You will have to reset the board once the image is uploaded to it.
+
+2. If you skipped the first option for the project [(downloading an image to SRAM)](#using-sram-to-make-led-blink), then skip this step. Otherwise, continue with this step.
+
+ By default, the linker script (`olimex_stm32-e407_devboard.ld`) is configured to run from bootloader and flash. However, if you first ran the image from SRAM you had changed `olimex_stm32-e407_devboard.ld` to match `run_from_sram.ld`. You will therefore return to defaults with `olimex_stm32-e407_devboard.ld` linker script matching the contents of 'run_from_loader.ld'. Return to the project directory.
+
+ $ cd ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard
+ $ diff olimex_stm32-e407_devboard.ld run_from_sram.ld
+ $ diff olimex_stm32-e407_devboard.ld run_from_loader.ld
+ $ cp run_from_loader.ld olimex_stm32-e407_devboard.ld
+ $ cd ~/dev/larva/project/blinky/bin/blinky
+
+3. In order to run the image from flash, you need to build the bootloader as well. The bootloader does the initial bring up of the Olimex board and then transfers control to the image stored at a location in flash known to it. The bootloader in turn requires the bin2image tool to check the image header for version information, CRC checks etc. So, we will need to build these two additional targets (bootloader and bin2img).
+
+ Let's first create bin2img:
+
+ $ newt target create bin2img
+ Creating target bin2img
+ Target bin2img successfully created!
+ $ newt target set bin2img arch=sim
+ Target bin2img successfully set arch to sim
+ $ newt target set bin2img compiler=sim
+ Target bin2img successfully set compiler to sim
+ $ newt target set bin2img project=bin2img
+ Target bin2img successfully set project to bin2img
+ $ newt target set bin2img compiler_def=debug
+ Target bin2img successfully set compiler_def to debug
+ $ newt target set bin2img bsp=hw/bsp/native
+ Target bin2img successfully set bsp to hw/bsp/native
+ $ newt target show bin2img
+ bin2img
+ arch: sim
+ compiler: sim
+ project: bin2img
+ compiler_def: debug
+ bsp: hw/bsp/native
+ name: bin2img
+
+ And then let's create boot_olimex:
+
+ $ newt target create boot_olimex
+ Creating target boot_olimex
+ Target boot_olimex successfully created!
+ $ newt target set boot_olimex arch=cortex_m4
+ Target boot_olimex successfully set arch to cortex_m4
+ $ newt target set boot_olimex compiler=arm-none-eabi-m4
+ Target boot_olimex successfully set compiler to arm-none-eabi-m4
+ $ newt target set boot_olimex project=boot
+ Target boot_olimex successfully set project to boot
+ $ newt target set boot_olimex compiler_def=optimized
+ Target boot_olimex successfully set compiler_def to optimized
+ $ newt target set boot_olimex bsp=hw/bsp/olimex_stm32-e407_devboard
+ Target boot_olimex successfully set bsp to hw/bsp/olimex_stm32-e407_devboard
+ $ newt target show boot_olimex
+ boot_olimex
+ project: boot
+ compiler_def: optimized
+ bsp: hw/bsp/olimex_stm32-e407_devboard
+ name: boot_olimex
+ arch: cortex_m4
+ compiler: arm-none-eabi-m4
+
+4. Let's build all the three targets now.
+
+ $ newt target build bin2img
+ Building target bin2img (project = bin2img)
+ Building project bin2img
+ Successfully run!
+ $ newt target build boot_olimex
+ Building target boot_olimex (project = boot)
+ Building project boot
+ Successfully run!
+ $ newt target build blinky
+ Building target blinky (project = blinky)
+ Building project blinky
+ Successfully run!
+
+
+5. Go to the project directory and download the bootloader and the image to flash ... in a flash!
+
+ $ cd ~/dev/larva/project/blinky/bin/blinky
+ $ newt target download boot_olimex
+ Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
+ $ newt target download blinky
+ Downloading with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_download.sh
+
+6. The LED should be blinking!
+
+7. But wait...let's double check that it is indeed booting from flash and making the LED blink from the image in flash. Pull the USB cable off the Olimex JTAG adaptor. The debug connection to the JTAG port is now severed. Next power off the Olimex board by pulling out the USB cable from the board. Wait for a couple of seconds and plug the USB cable back to the board.
+
+ The LED light will start blinking again. Success!
+
+ Note #1: If you want to download the image to flash and a gdb session opened up, use `newt target debug blinky` instead of `newt target download blinky`.
+
+ $ newt target debug blinky
+ Debugging with ~/dev/larva/hw/bsp/olimex_stm32-e407_devboard/olimex_stm32-e407_devboard_debug.sh blinky
+ Debugging ~/dev/larva/project/blinky/bin/blinky/blinky.elf
+ GNU gdb (GNU Tools for ARM Embedded Processors) 7.8.0.20150604-cvs
+ Copyright (C) 2014 Free Software Foundation, Inc.
+ License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+ This is free software: you are free to change and redistribute it.
+ There is NO WARRANTY, to the extent permitted by law. Type "show copying"
+ and "show warranty" for details.
+ This GDB was configured as "--host=x86_64-apple-darwin10 --target=arm-none-eabi".
+ Type "show configuration" for configuration details.
+ For bug reporting instructions, please see:
+ <http://www.gnu.org/software/gdb/bugs/>.
+ Find the GDB manual and other documentation resources online at:
+ <http://www.gnu.org/software/gdb/documentation/>.
+ For help, type "help".
+ Type "apropos word" to search for commands related to "word"...
+ Reading symbols from /Users/aditihilbert/dev/larva/project/blinky/bin/blinky/blinky.elf...done.
+ Open On-Chip Debugger 0.8.0 (2015-09-22-18:21)
+ Licensed under GNU GPL v2
+ For bug reports, read
+ http://openocd.sourceforge.net/doc/doxygen/bugs.html
+ Info : only one transport option; autoselect 'jtag'
+ adapter speed: 1000 kHz
+ adapter_nsrst_delay: 100
+ jtag_ntrst_delay: 100
+ Warn : target name is deprecated use: 'cortex_m'
+ DEPRECATED! use 'cortex_m' not 'cortex_m3'
+ cortex_m reset_config sysresetreq
+ Info : clock speed 1000 kHz
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ Info : stm32f4x.cpu: hardware has 6 breakpoints, 4 watchpoints
+ Info : JTAG tap: stm32f4x.cpu tap/device found: 0x4ba00477 (mfg: 0x23b, part: 0xba00, ver: 0x4)
+ Info : JTAG tap: stm32f4x.bs tap/device found: 0x06413041 (mfg: 0x020, part: 0x6413, ver: 0x0)
+ target state: halted
+ target halted due to debug-request, current mode: Thread
+ xPSR: 0x01000000 pc: 0x08000250 msp: 0x10010000
+ Info : accepting 'gdb' connection from 3333
+ Info : device id = 0x10036413
+ Info : flash size = 1024kbytes
+ Reset_Handler () at startup_STM32F40x.s:199
+ 199 ldr r1, =__etext
+ (gdb)
+
+
+ Note #2: If you want to erase the flash and load the image again you may use the following commands from within gdb. `flash erase_sector 0 0 x` tells it to erase sectors 0 through x. When you ask it to display (in hex notation) the contents of the sector starting at location 'lma' you should therefore see all f's. The memory location 0x8000000 is the start or origin of the flash memory contents and is specified in the olimex_stm32-e407_devboard.ld linker script. The flash memory locations is specific to the processor.
+
+ (gdb) monitor flash erase_sector 0 0 4
+ erased sectors 0 through 4 on flash bank 0 in 2.296712s
+ (gdb) monitor mdw 0x08000000 16
+ 0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000000: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (0x08000020: ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff
+ (gdb) monitor flash info 0
+
+
+ monitor flash erase_check 0
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/get_started/try_markdown.md
----------------------------------------------------------------------
diff --git a/docs/get_started/try_markdown.md b/docs/get_started/try_markdown.md
new file mode 100644
index 0000000..e35707c
--- /dev/null
+++ b/docs/get_started/try_markdown.md
@@ -0,0 +1,32 @@
+## Try Markdown
+
+### Heading3
+
+#### Heading4
+
+- - -
+
+##### List
+
+* Start with one # for the largest heading (Heading1). The next smaller heading (Heading2) starts with ##. You can go all the way up to Heading 6 (######).
+
+* Heading4 (####) and Heading5 (#####) has been styled to show up underlined. Yes, it can be changed. If you are curious, you can look at the extra.css file in your repo branch.
+
+* It's **very** easy to do **bold** and *italics*.
+
+* See how this list has been made using *
+
+* Click on "Help" in Mou and then on "Markdown Syntax Reference".
+
+* <font color="red"> Substitute a sentence of your own here </font>
+
+* <font color="red"> Guinea Pig!!! </font>
+
+---
+
+> <font color="red"> Note! </font>
+>> You will not be able to see the change immediately by refreshing your browser right after editign the Markdown file. You can only push the change to the Apache repository. So continue with the steps in [how_to_edit_docs.md](how_to_edit_docs.md).
+>>
+>> You can see the change on the website if/when a doc builder on the project team merges your changes to the master branch and generates the pages for the website.
+>>
+>> You do have the option to download MkDocs and preview the change by hosting the pages locally using its built-in web server. The steps are described in [how_to_edit_docs.md](how_to_edit_docs.md).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index ac13a84..b4974bf 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -67,17 +67,17 @@ To subscribe to a mailing list, you simply send an email to a special subscripti
The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter.
-* [Chapter 1: Get Started](chapter1/newt_concepts.md) introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.
+* [Chapter 1: Get Started](get_started/newt_concepts.md) introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.
-* [Chapter 2: Get Acclimated](chapter2/vocabulary.md) delves deeper into the concepts crucial to the software development effort.
+* [Chapter 2: Get Acclimated](get_acclimated/vocabulary.md) delves deeper into the concepts crucial to the software development effort.
-* [Chapter 3: Newt Tool Reference](chapter3/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
+* [Chapter 3: Newt Tool Reference](newt/newt_ops.md) describes the command structure and details all the available commands to help you with your project.
-* [Chapter 4: Newt OS](chapter4/mynewt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
+* [Chapter 4: Newt OS](os/newt_os.md) provides an overview of the features available and how to customize for your hardware and software application.
-* [Chapter 5: Modules](chapter5/console.md) lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.
+* [Chapter 5: Modules](modules/console.md) lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.
-* [Chapter 6: Creating packages for distribution](chapter6/dist.md) delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.
+* [Chapter 6: Creating packages for distribution](packaging/dist.md) delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.
### Contributing to Documentation
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/bootloader.md
----------------------------------------------------------------------
diff --git a/docs/modules/bootloader.md b/docs/modules/bootloader.md
new file mode 100644
index 0000000..381630a
--- /dev/null
+++ b/docs/modules/bootloader.md
@@ -0,0 +1,148 @@
+# Bootloader
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.>
+
+The functions available in this OS feature are:
+
+* [boot_slot_addr](#function-boot_slot_addr)
+* [boot_find_image_slot](#function-boot_find_image_slot)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function boot_slot_addr </font>
+
+```
+ static void
+ boot_slot_addr(int slot_num, uint8_t *flash_id, uint32_t *address)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function boot_find_image_slot </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/console.md
----------------------------------------------------------------------
diff --git a/docs/modules/console.md b/docs/modules/console.md
new file mode 100644
index 0000000..4e0bd73
--- /dev/null
+++ b/docs/modules/console.md
@@ -0,0 +1,546 @@
+# Console
+
+
+The console is an operating system window where users interact with system programs of the operating system or a console application by entering text input (typically from a keyboard) and reading text output (typically on the computer terminal). The text written on the console brings some information and is a sequence of characters sent by the OS or programs running on the OS.
+
+Support is currently available for console access via the serial port on the hardware board.
+
+
+## Description
+
+In the Mynewt OS, the console library comes in two versions:
+
+* full - containing the full implementation
+* stub - containing stubs for the API
+
+If an egg or project requires the full console capability it lists that dependency in its egg.yml file. For example, the shell egg is defined by the following egg.yml file:
+
+ egg.name: libs/shell
+ egg.vers: 0.1
+ egg.deps:
+ - libs/console/full
+ - libs/os
+ egg.identities:
+ - SHELL
+
+On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) but may have a dependency on an egg that has console capability. In that case you would use a console stub. Another example would be the bootloader project where we want to keep the size of the image small. It includes the `libs/os` egg that can print out messages on a console (e.g. if there is a hard fault) and the `libs/util` egg that uses full console (but only if SHELL is present to provide a CLI). However, we do not want to use any console I/O capability in this particular bootloader project to keep the size small. We simply use the console stub instead and the egg.yml file for the project boot egg looks like the following:
+
+ project.name: boot
+ project.identities: bootloader
+ project.eggs:
+ - libs/os
+ - libs/bootutil
+ - libs/nffs
+ - libs/console/stub
+ - libs/util
+
+## Data structures
+
+
+Console interaction is intrinsically composed of two unidirectional systems. The console implementation uses two ring buffers containing input (receive) and output (transmit) characters, respectively. Read and write operations on the console_ring structure are managed by labeling the read location indicator the `cr_tail` and the write location indicator the `cr_head`. The console ring length is variable and is specified as the `cr_size` member of the data structure. `cr_buf` is the pointer to the actual array of data contained.
+
+
+```
+struct console_ring {
+ 32 uint8_t cr_head;
+ 33 uint8_t cr_tail;
+ 34 uint8_t cr_size;
+ 35 uint8_t _pad;
+ 36 uint8_t *cr_buf;
+ 37 }
+```
+
+
+```
+struct console_tty {
+ 40 struct console_ring ct_tx;
+ 41 uint8_t ct_tx_buf[CONSOLE_TX_BUF_SZ]; /* must be after console_ring */
+ 42 struct console_ring ct_rx;
+ 43 uint8_t ct_rx_buf[CONSOLE_RX_BUF_SZ]; /* must be after console_ring */
+ 44 console_rx_cb ct_rx_cb; /* callback that input is ready */
+ 45 console_write_char ct_write_char;
+ 46 } console_tty
+```
+
+## List of Functions
+
+The functions available in console are:
+
+* [console_printf](#function-console_printf)
+* [console_add_char](#function-console_add_char)
+* [console_pull_char](#function-console_pull_char)
+* [console_pull_char_head](#function-console_pull_char_head)
+* [console_queue_char](#function-console_queue_char)
+* [console_blocking_tx](#function-console_blocking_tx)
+* [console_blocking_mode](#function-console_blocking_mode)
+* [console_write](#function-console_write)
+* [console_read](#function-console_read)
+* [console_tx_char](#function-console_tx_char)
+* [console_rx_char](#function-console_rx_char)
+* [console_init](#function-console_init)
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function console_printf</font>
+
+```
+ void
+ console_printf(const char *fmt, ...)
+```
+
+Writes a formatted message instead of raw output to the console. It first composes a C string containing text specified as arguments to the function or containing the elements in the variable argument list passed to it using snprintf or vsnprintf, respectively. It then uses function `console_write` to output the formatted data (messages) on the console.
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| fmt | Pointer to C string that contains a format string that follows the same specifications as format in printf. The string is printed to console. |
+| ... | Depending on the format string, the function may expect either a sequence of additional arguments to be used to replace a format specifier in the format string or a variable arguments list. va_list is a special type defined in <cstdarg> in stdarg.h. |
+
+#### Returned values
+
+None
+
+#### Notes
+
+While `console_printf`, with its well understood formatting options in C, is more convenient and easy on the eyes than the raw output of `console_write`, the associated code size is considerably larger.
+
+#### Example
+Example #1:
+
+```
+char adv_data_buf[32];
+
+void
+task()
+{
+ char adv_data_buf[32];
+
+ console_printf("%s", adv_data_buf);
+}
+```
+
+Example #2:
+
+```
+struct exception_frame {
+ uint32_t r0;
+ uint32_t r1;
+
+struct trap_frame {
+ struct exception_frame *ef;
+ uint32_t r2;
+ uint32_t r3;
+};
+
+void
+task(struct trap_frame *tf)
+{
+ console_printf(" r0:%8.8x r1:%8.8x", tf->ef->r0, tf->ef->r1);
+ console_printf(" r8:%8.8x r9:%8.8x", tf->r2, tf->r3);
+}
+```
+
+---------------------
+
+### <font color="#2980b9"> function console_add_char</font>
+
+```
+ static void
+ console_add_char(struct console_ring *cr, char ch)
+```
+
+Adds a character to the console ring buffer. When you store an item in the buffer you store it at the head location, and the head advances to the next location.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| *cr | Pointer to a console ring data structure whose `cr_head` variable is to be set to the second argument in this function call|
+| ch | Character to be inserted to the ring |
+
+#### Returned values
+
+None
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Add a new line character to the output (transmit) buffer.
+
+```
+void
+task()
+{
+ struct console_ring *tx = &ct->ct_tx;
+
+ console_add_char(tx, '\n');
+}
+```
+
+-------------------
+
+### <font color="#2980b9"> function console_pull_char </font>
+
+```
+ static uint8_t
+ console_pull_char(struct console_ring *cr)
+```
+
+Reads (remove) a byte from the console ring buffer. When you read (pull) an item, you read it at the current tail location, and the tail advances to the next position.
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| *cr | Pointer to the console ring buffer from where a character is to be removed |
+
+
+#### Returned values
+
+Returns the character pulled from the ring buffer.
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Read the characters in the ring buffer into a string.
+
+```
+void
+task(struct console_ring *cr, char *str, int cnt)
+{
+ for (i = 0; i < cnt; i++) {
+ if (cr->cr_head == cr->cr_tail) {
+ i = -1;
+ break;
+ }
+ ch = console_pull_char(cr);
+ *str++ = ch;
+ }
+}
+```
+
+---------------
+
+### <font color="#2980b9"> function console_pull_char_head </font>
+
+```
+ static void
+ console_pull_char_head(struct console_ring *cr)
+```
+
+Removes the last character inserted into the ring buffer by moving back the head location and shrinking the ring size by 1.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| cr | Pointer to the console ring buffer from which the last inserted character must be deleted |
+
+
+#### Returned values
+
+None
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+In order to see a character getting deleted when a user hits backspace while typying a command, the following needs to happen in sequence:
+
+* output a backspace (move cursor back one character)
+* output space (erasing whatever character there was before)
+* output backspace (move cursor back one character)
+* remove the previous character from incoming RX queue
+
+The example below shows console_pull_char_head being used for the last step.
+
+```
+void
+task(uint8_t data)
+{
+ struct console_tty *ct = (struct console_tty *)arg;
+ struct console_ring *tx = &ct->ct_tx;
+ struct console_ring *rx = &ct->ct_rx;
+
+ switch (data) {
+ case '\b':
+ console_add_char(tx, '\b');
+ console_add_char(tx, ' ');
+ console_add_char(tx, '\b');
+ console_pull_char_head(rx);
+ break;
+ }
+}
+
+```
+
+-------------
+
+### <font color="#2980b9"> function console_queue_char </font>
+
+```
+ static void
+ console_queue_char(char ch)
+```
+
+Manage the buffer queue before inserting a character into it. If the head of the output (transmit) console ring is right up to its tail, the queue needs to be drained first before any data can be added. Then it uses console_add_char function to add the character.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| ch | Character to be inserted to the queue |
+
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+This function makes sure no interrupts are allowed while the transmit buffer is draining and the character is being added.
+
+#### Example
+
+```
+Insert example
+```
+------------------
+
+### <font color="#2980b9"> function console_blocking_tx </font>
+
+```
+ static void
+ console_blocking_tx(char ch)
+```
+
+ Calls the hal function hal_uart_blocking_tx to transmit a byte to the console over UART in a blocking mode until the character has been sent. Hence it must be called with interrupts disabled. It is used when printing diagnostic output from system crash.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+-----------
+
+### <font color="#2980b9"> function console_blocking_mode </font>
+
+```
+ void
+ console_blocking_mode(void)
+```
+ Calls the console_blocking_tx function to flush the buffered console output (transmit) queue. The function OS_ENTER_CRITICAL() is called to disable interrupts and OS_EXIT_CRITICAL() is called to enable interrupts back again once the buffer is flushed.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9">function console_write </font>
+
+```
+ void
+ console_write(char *str, int cnt)
+```
+Transmit characters to console display over serial port.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_read </font>
+
+```
+ int
+ console_read(char *str, int cnt)
+```
+ Calls hal function hal_uart_start_rx to start receiving input from console terminal over serial port.
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_tx_char </font>
+
+ ```
+ static int
+ console_tx_char(void *arg)
+ ```
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_rx_char </font>
+
+```
+ static int
+ console_rx_char(void *arg, uint8_t data)
+```
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
+
+
+### <font color="#2980b9"> function console_init </font>
+
+```
+ int
+ console_init(console_rx_cb rx_cb)
+```
+
+ Initializes console receive buffer and calls hal funtions hal_uart_init_cbs and hal_uart_config to initialize serial port connection and configure it (e.g. baud rate, flow control etc.)
+
+#### Arguments
+
+| Arguments | Description |
+|-------------------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+Give at least one example of usage.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/modules/filesystem.md b/docs/modules/filesystem.md
new file mode 100644
index 0000000..dc1ad43
--- /dev/null
+++ b/docs/modules/filesystem.md
@@ -0,0 +1,149 @@
+# Filesystem
+
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.>
+
+The functions available in this OS feature are:
+
+* [nffs_lock](#function-nffs_lock)
+* [nffs_unlock](#function-nffs_unlock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function nffs_lock </font>
+
+```
+ static void
+ nffs_lock(void)
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function nffs_unlock </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8aced2b5/docs/modules/shell.md
----------------------------------------------------------------------
diff --git a/docs/modules/shell.md b/docs/modules/shell.md
new file mode 100644
index 0000000..1b2928a
--- /dev/null
+++ b/docs/modules/shell.md
@@ -0,0 +1,147 @@
+# Shell
+
+Insert synopsis here
+
+
+## Description
+
+Describe module here, special features, how pieces fit together etc.
+
+## Data structures
+
+Replace this with the list of data structures used, why, any neat features
+
+## List of Functions
+
+<List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.>
+
+The functions available in this OS feature are:
+
+* [shell_cmd_list_lock](#function-shell_cmd_list_lock)
+* [shell_cmd_list_unlock](#function-shell_cmd_list_unlock)
+* add the rest
+
+
+## Function Reference
+
+------------------
+
+### <font color="2980b9">function shell_cmd_list_lock </font>
+
+```
+ static int
+ shell_cmd_list_lock(void)
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function shell_cmd_list_unlock </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------
+
+### <font color="#2980b9"> function next_one </font>
+
+```
+ <Insert function callout here >
+
+```
+
+<Insert short description>
+
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| xx | explain argument xx |
+| yy | explain argument yy |
+
+#### Returned values
+
+List any values returned.
+Error codes?
+
+#### Notes
+
+Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).
+
+#### Example
+
+<Add text to set up the context for the example here>
+
+```
+
+<Insert the code snippet here>
+
+```
+
+---------------------