Add doc on tflm op support in Kelvin.

Change-Id: Ie1a033eeb00d331fc88ef197960ce1abad5a34cf
1 file changed
tree: 34b2727a54594eeb81ec978e368785031f7a6134
  1. benchmarks/
  2. build_tools/
  3. crt/
  4. docs/
  5. examples/
  6. host_tools/
  7. platforms/
  8. tests/
  9. tflm/
  10. third_party/
  11. toolchains/
  12. .bazelrc
  13. .bazelversion
  14. .gitignore
  15. CONTRIBUTING.md
  16. LICENSE
  17. PREUPLOAD.cfg
  18. README.md
  19. 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.