Google Git
Sign in
opensecura / sw / kelvin / 288b9e9ee706f85eaf3b243717e5dbefd5298dc6
commit288b9e9ee706f85eaf3b243717e5dbefd5298dc6[log] [tgz]
authorAlex Van Damme <atv@google.com>Mon Aug 21 13:36:21 2023 -0700
committerAlex Van Damme <atv@google.com>Mon Aug 21 22:50:09 2023 +0000
treec97d49bc9751835ceb48308f01a3ad77b7e774da
parentc53e7142e71e318e8a275db409a24c7f6a59e37d [diff]
Switch addition to vdmulh, fix rounding

- Now that the vdmulh bug was corrected in sim, we can use it instead of
  vmulh + vmul
- Enable rounding during the shift in our rescale macro, this fixes
  off-by-one errors seen in Soundstream's use of Add.
- clang-format the rescale macro

Change-Id: I01c11bf19a475a6768fab74cde3a4b6ec64d8c14
1 file changed
tree: c97d49bc9751835ceb48308f01a3ad77b7e774da
  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.