Google Git
Sign in
opensecura / sw / kelvin / 0db1c37eb56338f5ca49e5aca374c1bb20ebade6
commit0db1c37eb56338f5ca49e5aca374c1bb20ebade6[log] [tgz]
authorAlex Van Damme <atv@google.com>Thu Aug 10 10:07:06 2023 -0700
committerAlex Van Damme <atv@google.com>Mon Aug 14 15:45:22 2023 -0700
tree238e3d4b87800f62104501e563a27e2d1e5e343e
parenta30fe74251e6c04c3df65c13dbccfadb3d8692b0 [diff]
Modify kelvin _start to ebreak on non-zero exit code

- If main returns something non-zero, call ebreak.
- If main returns zero, still call mpause.
- In either case, infinite loop afterwards.
- This allows tests to fail by returning non-zero :) (ISA tests were
  able to fail before, because their failure macro explicitly called
  ebreak)

Change-Id: I876dca468b75784703cdba1f7049188fce6e1eb0
1 file changed
tree: 238e3d4b87800f62104501e563a27e2d1e5e343e
  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. README.md
  15. 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.