ubirch meta-project (superbuild)

This is a special repository, created to make building the toolchain simpler by compiling all configurations in one go and making the targets available for other projects.

The following commands will create the default toolchain for all known board revisions of ubirch#1, FRDM-K82F, and FRDM-KL82Z, as well as all known MCUs (currently just the K82F25615, KL82Z) for all types of configuration (Debug, Release, RelWithDebInfo, MinSizeRel):

brew install cmake
brew tap armmbed/formulae
brew install arm-none-eabi-gcc

git clone git@github.com:ubirch/ubirch-meta.git
cd ubirch-meta
./build.sh -a

If at a later stage you would like to re-run the build because some of the libraries/repositories have changed, run ./build.sh -u -a which includes a git pull step.

For running a complete rebuild, cleaning the registry, run ./build.sh -c -u -a, which will prompt you before executing the rm commands for cleanup, then update the repository and do a complete rebuild.

The build script will clone the source directories directly into this directory. Ignore them unless you want to work on them! Don't forget to commit changes back into the repository.

Dependencies

ubirch-arm-toolchain - needed for a all build processes
ubirch-kinetis-sdk - a repository containing the licensed SDK (from NXP)
ubirch-kinetis-sdk-package - the Kinetis SDK package builder
ubirch-board-firmware - the board firmware package builder
ubirch-wolfssl - a fork of the wolfSSL repository with patches for Kinetis SDK 2.0
ubirch-wolfssl-package - the wolfSSL package builder
ubirch-board-crypto - board specific crypto layer

The final ubirch-board-firmware and ubirch-crypto then be used in other projects, importing it using:

require(PACKAGE ubirch BOARD ${BOARD} VERSION 1.0)
require(PACKAGE crypto BOARD ${BOARD} VERSION 1.0)

See ubirch-project-template for an example how to use the toolchain in your own project. Other examples can be found in our ubirch github repository.

Dependency Graph (firmware):

ubirch-arm-toolchain --+--------------------------------+
                       |                                |
ubirch-kinetis-sdk ----+-- ubirch-kinetis-sdk-package --+-- [ubirch-board-firmware]

Dependency Graph (crypto support, requires ubirch-board-firmware):

[ubirch-board-firmware] ----------------------------+
                                                    |
ubirch-wolfssl ----------- ubirch-wolfssl-package --+-- [ubirch-board-crypto]

Documentation

After building the meta build the documentation can be found locally in docs
An online version of the firmware documentation is hosted on developer.ubirch.com
You will find the [Kinetis SDK Documentation](ubirch-kinetis-sdk/SDK_2.0_MK82FN256xxx15/docs/Kinetis SDK v.2.0 API Reference Manual/index.html) in the ubirch-kinetis-sdk directory.

License

If not otherwise noted in the individual files, the code in this repository is

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.