Image Builder
=============

This is the image builder for the Librem5 and related boards:

* *devkit*: The [Librem 5 Devkit][0]
* *ec-som*: Emcraft's [i.MX 8M SOM Starter Kit][1]
* *imx8*: [NXPs IMX8M Evaluation Kit][2]
* *imx6*: The Bounday Devices [Nit6QP_MAX][3]
* *qemu-x86_64*: The [QEMU Image][4]

It supports various distributions (PureOS *laboratory* and *purple*, Debian
*buster*).  Additionally it can add our on commit built CI packages to get
the latest versions of the Librem 5 related sofware.

Furthermore it can incorporate different kernel versions:

* *latest*: Fetch the most recently built kernel
* *ci*: deprecated, don't use
* *unstable*: Pre release kernels (that got some testing)
* *stable*: Released kernels (none of them exist yet)

So to build an image with all the latest software you'd use:

    ./build-image -T latest -b devkit -d buster+ci

or just issue

    make

# Build u-boot

The build_uboot.sh script can build u-boots for a number of targets

* *devkit-recovery*: This is to boot the [Librem 5 Devkit][0] via SDP
* *devkit*: The [Librem 5 Devkit][0]
* *ec-som*: Emcraft's [i.MX 8M SOM Starter Kit][1]
* *imx8*: [NXPs IMX8M Evaluation Kit][2]
* *imx6*: The Bounday Devices [Nit6QP_MAX][3]

From the build directory invoke build_uboot.sh

    cd build 
    ./build_uboot.sh -b devkit

# Creating a bootable SD card

This is only relevant for SD card booting on e.g. the Nitrogen or NXP
boards:

The SD card must be larger than 3G. Replace <x> with the SD card device.

    sudo dd if=imx6.img of=/dev/sd<x> bs=4M

or a bit more verbose and using the compressed image

    bin/write-image of=/dev/sd<x>

Note: All data on the SD card will be overwritten.

# Running the tests

You can run tests against an installed board using

    sudo apt -y install ruby-serverspec
    cd tests
    TARGET_HOST=<your_board_ip> rake spec:nitrogen6

[0]: https://developer.puri.sm/Librem5/Hardware_Reference.html#librem-5-devkit
[1]: https://www.emcraft.com/products/868
[2]: https://www.nxp.com/support/developer-resources/run-time-software/i.mx-developer-resources/evaluation-kit-for-the-i.mx-8m-applications-processor:MCIMX8M-EVK
[3]: https://boundarydevices.com/product/nitrogen6max/
[4]: https://developer.puri.sm/Librem5/Development_Environment/Boards/qemu.html#qemu