Changes between Version 21 and Version 22 of newport

Timestamp:

12/20/2017 06:36:33 PM (7 years ago)

Author:

Tim Harvey

Comment:

added BSP section

newport

@@ -56 +56 @@
 
 == Software ==
- * [#source Source code for Newport including keeping abreast of changes]
+ * [#bsp Gateworks Newport Board Support Package]
  * [#images Pre-built Firmware Images]
  * [#firmware Boot Firmware (up to and including the Bootloader)]
@@ -101 +101 @@
 
 
+[=#bsp]
+= Newport Board Support Package (BSP) =
+Gateworks provides a Board Support Package for Newport which provides source code and an easy mechanism to build:
+ * Gateworks Newport Linux Kernel
+ * Gateworks Newport Boot Firmware
+
 [=#source]
-= Source Code =
+== BSP Source Code ==
 Newport Source code for the firmware, bootloader and kernel are hosted at !GitHub. We highly recommend you create a !GitHub account and 'Watch' these repositories to keep abreast of important feature additions, bugfixes, and firmware-releases. You can configure your !GitHub account to e-mail you when changes are made to repositories [https://github.com/settings/notifications here].
 
@@ -115 +121 @@
 
 [=#images]
-= Pre-built Firmware Images =
+== Pre-built Firmware Images ==
 The [https://github.com/Gateworks/uboot-newport images-newport] !GitHub repository hosts various pre-built firmware images used for Newport:
  * [https://github.com/Gateworks/images-newport/raw/master/gsc_630x.txt GSC firmware image]
@@ -122 +128 @@
  * Download xenial-newport.img.gz from [https://github.com/Gateworks/images-newport/releases/latest latest Newport firmware release] - Compressed Disk Image containing Firmware and Ubuntu 16.04 Xenial 
  * [http://dev.gateworks.com/newport/ubuntu/xenial/latest/xenial-newport.tar.xz xenial-newport.tar.xz] - Compressed TAR archive of Ubuntu 16.04 Xenial arm64 root filesystem
+
+
+[=#build]
+== Building BSP from source ==
+The Gateworks Newport Board Support Package uses the Google {{{repo}}} tool to manage multiple code repositories.
+
+The following pre-requisites are needed to build the Newport BSP:
+ * Linux Development host (Ubuntu 16.04 is used by Gateworks and tested)
+ * Python 2.x (required by the 'repo' tool)
+ * Git (used for source code repositories)
+
+To obtain the code:
+ 1. Get repo tool (download latest version of tool and put it in your path)
+{{{#!bash
+mkdir $HOME/.bin/
+export PATH=\$PATH:$HOME/.bin/repo >> $HOME/.profile
+curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/.bin/repo
+chmod a+x $HOME/.bin/repo
+}}}
+ 2. Initialize repo (fetch the repo manifest)
+{{{#!bash
+mkdir $HOME/newport
+cd $HOME/newport
+repo init -u https://github.com/Gateworks/manifest-newport.git
+}}}
+ 3. Sync repositories (repeat this when you want to fetch the latest code updates)
+{{{#!bash
+repo sync
+}}}
+  * This will fetch/update the source repos described [#source above]. The first time it can take several minutes depending on your Internet connection and will take approximately ~2.5GB of disk space
+ 4. Build 'Boot Firmware' (takes about 2 mins on a modern development system)
+{{{#!bash
+make -j8 firmware # build boot firmware using 8 sub-processes
+}}}
+  * additional targets you may want to make include 'linux' to build the Linux kernel
+
+The resulting {{{firmware-newport.img}}} can be installed to boot media (see [#firmware-update below])
 
 
@@ -262 +305 @@
 
 Gateworks provides a pre-built Boot Firmware (firmware-newport.img) ready to flash onto boot devices as well as source for building and/or modifying the boot firmware yourself.
+
 
 [=#bootrom]