Check out the official Kubos Linux documentation for the most current instructions on how to setup and interact with Kubos Linux on specific boards. Kubos uses BuildRoot as its main Linux build tool. This repo contains the configuration and patch files required by BuildRoot to build Linux for each of the OBCs that Kubos supports.
Want to get your code to space? Become a contributor! Check out our doc on contributing to KubOS and come talk to us on Slack to join our community. Or, if you're just looking to give some feedback, submit an issue with your feature requests or bug reports!
This file contains the name and description for the kubos-linux-build folder. BuildRoot will use it to create a link between the main BuildRoot folder and the kubos-linux-build folder.
Currently (intentionally) empty. This file is required by BuildRoot when creating the external link to the kubos-linux-build folder, but no content is actually required.
Currently empty. Same as the external.mk file, BuildRoot requires that this file exist, but not that it have any content.
Inside of each of these folders are the patches and configuration files for each of the components required to build Linux for a particular board.
This folder contains the BuildRoot configuration files needed to build each OBC supported by Kubos.
In order to build Kubos Linux, two components are needed:
- The kubos-linux-build repo - Contains the configurations, patches, and extra tools needed to build Kubos Linux
- BuildRoot - The actual build system
These components should be setup as children of the same parent directory. There are several commands and variables in the build process which use relative file paths to navigate between the components.
After the environment has been set up, all build commands will be run from the BuildRoot directory unless otherwise stated.
To set up a build environment and build Kubos Linux:
Create a new parent folder to contain the build environment
$ mkdir kubos-linux
Enter the new folder
$ cd kubos-linux
Download BuildRoot-2019.02.2 (more current versions of BuildRoot may work as well, but all testing has been done against 2019.02.2)
.. note:: All Kubos documentation will refer to v2019.02.2, which is the latest version of the LTS release at the time of this writing.
$ wget https://buildroot.uclibc.org/downloads/buildroot-2019.02.2.tar.gz && tar xvzf buildroot-2019.02.2.tar.gz && rm buildroot-2019.02.2.tar.gz
Pull the kubos-linux-build repo
$ git clone http://github.com/kubos/kubos-linux-build
Move into the buildroot directory
$ cd buildroot-2019.02.2
Point BuildRoot to the external kubos-linux-build folder and tell it which configuration you want to run (config files are located in kubos-linux-build/configs)
$ make BR2_EXTERNAL=../kubos-linux-build {board}_defconfig
Build everything
$ sudo make
The full build process will take a while. Running on a Linux VM, it took about an hour. Running in native Linux, it took about twenty minutes. Once this build process has completed once, you can run other BuildRoot commands to rebuild only certain sections and it will go much more quickly (<5 min).
Note: If you're using Vagrant, as with the Kubos SDK, do not use a shared folder for the kubos-linux-build or buildroot directories, as the build process uses hardlinks that error with vagrant's shared folders.
BuildRoot documentation can be found here
The generated files will be located in buildroot-2019.02.2/output/images. They are:
- uboot.bin - The U-Boot binary
- kernel - The compressed Linux kernel file
- {board}.dtb - The Device Tree Binary that Linux uses to configure itself for your board
- rootfs.tar - The root file system. Contains BusyBox and other libraries
These files may be further packaged into various system images. Specific details are listed in the appropriate Building Linux for {OBC} doc.