Google Git
Sign in
opensecura / sw / kelvin / e525be012f188e598aa8b84d671a313f7264983a
commite525be012f188e598aa8b84d671a313f7264983a[log] [tgz]
authorAlex Van Damme <atv@google.com>Thu Sep 21 16:24:55 2023 -0700
committerAlex Van Damme <atv@google.com>Thu Sep 21 16:24:55 2023 -0700
tree9a37aef5e19cd0a60a5c70cd0b1a1c7b2f3f59b7
parentc2239bd8798085322925fc2f10e33ef0c60abac7 [diff]
Remove remaining C++ from kelvin.h, include in hello_world

- Remove the inclusion of <algorithm> from kelvin.h, so that there is no
  C++ remaining and we can include it from C.
- Include the header in hello_world, so that there is a canary for any
  modifications to kelvin.h that would be incompatible.

Change-Id: I1d147395cd85c8f9ff6edae3593d5a68f1fed177
2 files changed
tree: 9a37aef5e19cd0a60a5c70cd0b1a1c7b2f3f59b7
  1. build_tools/
  2. crt/
  3. docs/
  4. examples/
  5. host_tools/
  6. platforms/
  7. tests/
  8. tflm/
  9. third_party/
  10. toolchains/
  11. .bazelrc
  12. .bazelversion
  13. .gitignore
  14. PREUPLOAD.cfg
  15. README.md
  16. WORKSPACE
README.md

Kelvin SW Repository

This project contains the BSP to build the SW artifact that can run on the Kelvin core, and integrated as part of the Shodan repository.

The project supports two build systems -- Bazel and CMake -- for OSS integration reasons. Bazel is used by TFLM flow, while CMake is the build system for IREE.

Prerequisite

If you get this project from Project Shodan manifest, you are all set. If not, you need to have following projects as well to build the project successfully.

  • Kelvin crosscompile toolchain: Under <dir>/cache/toolchain_kelvin

This project needs to be at <dir>/sw/kelvin.

Code structure

  • build_tools: Build tool/rules for both Bazel and CMake
  • crt: Kelvin BSP
  • examples: Source code to build Kelvin SW artifacts.
  • host_tools: host tool to generate the intrinsic header and toolchain op files
  • platforms: Crosscompile platform setup for Bazel.
  • tests: Tests to exercise features of the Kelvin core.
  • tflm: Support code and optimized routines for TFLM.
  • third_party: Third party repositories for Bazel.
  • toolchains: Crosscomple toolchain setup for Bazel.

Build the project

Bazel

The project uses Bazel 5.1.1, to align with OpenTitan build system requirements.

bazel build //...

To run the unit tests (with the kelvin_sim ISS) Make sure the Environment variable $ROOTDIR is set to the root directory of the local repo (or run source build/setup.sh)

bazel test //...

CMake

TODO: Add CMake flow

Run the executable

The binaries can be simulated with the kelvin simulator, located at <dir>/sim/kelvin.

sim_kelvin <elf location>

Load the generated .bin binaries to the FPGA emulator/Renode simulator.