[[PageOutline]]

= Newport Board Support Package (BSP) =
Gateworks provides a Board Support Package for Newport which provides source code and an easy mechanism to build:
 * [wiki:#kernel Gateworks Newport Linux Kernel]
 * [wiki:newport/boot Gateworks Newport Boot Firmware]
 * [wiki:#openwrt Gateworks Newport OpenWrt]

[=#source]
== 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].

The following !GitHub repos are used for Newport:
 * [https://github.com/Gateworks/bsp-newport] - Newport BSP support scripts and Makefile  ([https://github.com/Gateworks/bsp-newport/subscription watch])
 * [https://github.com/Gateworks/manifest-newport] - Newport BSP repo Manifest  ([https://github.com/Gateworks/manifest-newport/subscription watch])
 * [https://github.com/Gateworks/images-newport images-newport] - Newport pre-built firmware Firmware Images ([https://github.com/Gateworks/images-newport/subscription watch])
 * [https://github.com/Gateworks/uboot-newport uboot-newport] - Newport Bootloader ([https://github.com/Gateworks/uboot-newport/subscription watch)]
 * [https://github.com/Gateworks/linux-newport linux-newport] - Newport Linux Kernel ([https://github.com/Gateworks/linux-newport/subscription watch)]
 * [https://github.com/Gateworks/dts-newport dts-newport] - Newport Linux Device-Tree ([https://github.com/Gateworks/dts-newport/subscription watch)]
 * [https://github.com/Gateworks/bdk-newport bdk-newport] - Newport BDK (used as Secondary Program Loader) ([https://github.com/Gateworks/bdk-newport/subscription watch)]
 * [https://github.com/Gateworks/atf-newport atf-newport] - Newport ATF (ARM Trusted Firmware) ([https://github.com/Gateworks/atf-newport/subscription watch)]
 * [https://github.com/Gateworks/openwrt openwrt] - Gateworks OpenWrt ([https://github.com/Gateworks/openwrt/subscription watch)]


[=#images]
== Pre-built Firmware Images ==
Pre-built firmware images can be found on http://dev.gateworks.com/newport:
 * [http://dev.gateworks.com/newport/images/gsc_630x.txt GSC firmware image]
 * [http://dev.gateworks.com/newport/boot_firmware/firmware-newport.img firmware-newport.img] Boot Firmware (everything up to and including the bootloader stored on the embedded FLASH boot device) (see [wiki:newport/boot newport/boot] for details)
 * [http://dev.gateworks.com/newport/kernel/linux-newport.tar.xz linux-newport.tar.xz] - Compressed TAR archive of pre-built Linux kernel
 * [http://dev.gateworks.com/newport/images/xenial-newport.img.gz xenial-newport.img.gz] - Compressed Disk Image containing Firmware and Ubuntu 16.04 Xenial
 * [http://dev.gateworks.com/newport/images/openwrt-newport.img.gz openwrt-newport.img.gz] - Compressed Disk Image containing Firmware and OpenWrt
 * [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 ==
Below are instructions for building all of the bootloader components and Linux kernel. This does not include Ubuntu or any other operating systems. Pre-built images are available [#images above].

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 (desktop or laptop computer) (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/
echo "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
}}}
 1. Initialize repo (fetch the repo manifest)
{{{#!bash
mkdir $HOME/newport
cd $HOME/newport
repo init -u https://github.com/Gateworks/manifest-newport.git
}}}
 1. 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
 1. Setup build environment (***repeat this each time you open shell***)
{{{#!bash
source newport/setup-environment
}}}
 1. Build desired targets and images. For example:
{{{#!bash
make -j8 openwrt-image # build openwrt-newport.img.gz
}}}

The build targets supported by the Newport BSP include:
  * **firmware-image** - builds 'firmware-newport.img': 16MB [wiki:newport/boot Boot Firmware] which includes the BDK/ATF/U-Boot and Device-Tree images - (takes about 2 mins on a modern development system).
  * **kernel_image** - builds linux-newport.tar.xz - A compressed tarball of the kernel (boot/Image) and kernel modules (lib/modules/*) which can be used on top of any compatible root filesystem 
  * **ubuntu-image** - builds ubuntu-newport.img.gz: A Compressed Disk Image which includes the 16MB [wiki:newport/boot Boot Firmware] (BDK/ATF/U-Boot and Device-Tree images) as well as the Kernel and Ubuntu root filesystem
  * **openwrt-image** - builds openwrt-newport.img.gz: A Compressed Disk Image which includes the 16MB [wiki:newport/boot Boot Firmware] (BDK/ATF/U-Boot and Device-Tree images) as well as the OpenWrt Kenrel and root filesystem

The resulting images can be installed to boot media (see [wiki:newport#firmware-update newport/firmware-update])


[=#kernel]
== Building or modifying the Linux Kernel ==
The Gateworks Newport BSP instructions [#bsp above] create an environment for building the Linux kernel among other targets.

Here are some additional instructions for common actions (make sure you have installed the BSP and setup your shell environment as specified above):
 * Modify Kernel configuration (enabling modules etc):
{{{#!bash
cd linux
make newport_defconfig # start with the Newport kernel configuration
make menuconfig # modify as desired
make # build Image and modules
}}}
 * Build kernel tarball:
{{{#!bash
cd linux
make # build Image and modules
mkdir -p install/boot # create install and install/boot directories
cp arch/arm64/boot/Image install/boot # copy kernel Image
make INSTALL_MOD_PATH=install modules_install # install modules
tar -cvJf /tftpboot/newport/linux-newport.tar.xz --numeric-owner -C install . # create tarball
}}}

While the resulting kernel modules must be placed on the root filesystem the kernel image must be placed in a partition readable by the U-Boot Bootloader. Therefore placing the kernel within the root filesystem as above does not work if you use a filesystem that U-Boot does not natively support (like F2FS or BTRFS for example). U-Boot only supports FAT and EXT (and UBI for NAND devices) natively.


== Building Ubuntu Operating System - rootfs ==
This is not part of the Gateworks BSP described above. 

Information for building Ubuntu rootfs can be found here: [wiki:newport/ubuntu]