Google Git
Sign in
opensecura / sw / kelvin / da93a9a12b00006ec9074f85a41aac751a65d43a
commitda93a9a12b00006ec9074f85a41aac751a65d43a[log] [tgz]
authorCindy Liu <hcindyl@google.com>Thu Aug 03 17:57:26 2023 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>Thu Aug 03 17:57:26 2023 +0000
tree77c4f53a27f14690cb53748d3521ce5a33f11be2
parent9ae79f5510c615a13259855e1393bed8bdb4dd21 [diff]
parentba583f11bfc93327bb1178e8883435c8591bb415 [diff]
Merge "Update the Kelvin ISA spec for the scalar register encoding."
tree: 77c4f53a27f14690cb53748d3521ce5a33f11be2
  1. build_tools/
  2. crt/
  3. docs/
  4. examples/
  5. host_tools/
  6. platforms/
  7. tests/
  8. third_party/
  9. toolchains/
  10. .bazelrc
  11. .bazelversion
  12. .gitignore
  13. README.md
  14. 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.
  • platforms: Crosscompile platform setup for Bazel.
  • third_party: Third party repositories for Bazel.
  • toolchains: Crosscomple toolchain setup for Bazel.
  • host_tools: host tool to generate the intrinsic header and toolchain op files

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)

bazel test --test_env=ROOTDIR=${ROOTDIR} //...

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.