TROPIC01's SDK written in C. Contributors, please follow guidelines.
For more information about TROPIC01 chip and its datasheet or User API, check out developers resources in the TROPIC01 repository.
We recommend using the Libtropic documentation as the source of truth for getting information about Libtropic.
The documentation is generated only for the releases and the version can be switched via the version selector at the top of the page.
For the Libtropic library to function correctly with the TROPIC01 secure element, the versions of four key components must be compatible:
- Libtropic SDK: The version of this library.
- Bootloader FW: Bootloader firmware running on the TROPIC01's RISC-V CPU after power-up. It cannot be updated.
- Application FW: Application firmware running on the TROPIC01's RISC-V CPU. It can be updated.
- SPECT FW: Firmware running on the TROPIC01's SPECT co-processor. It can be updated.
For more information about each of these, refer to the TROPIC01 repository.
The following table outlines the tested and supported compatibility between released versions:
| Libtropic | Application FW | SPECT FW | Bootloader FW | Tests |
|---|---|---|---|---|
| 1.0.0 | 1.0.0 | 1.0.0 | 1.0.1-2.0.1 | ✅ |
| 2.0.0 | 1.0.0–1.0.1 | 1.0.0 | 2.0.1 | ✅ |
| 2.0.1 | 1.0.0–1.0.1 | 1.0.0 | 2.0.1 | ✅ |
| 3.0.0 | 1.0.0–2.0.0 | 1.0.0 | 2.0.1 | ✅ |
| 3.1.0 | 1.0.0–2.0.0 | 1.0.0 | 2.0.1 | ✅ |
Warning
Using mismatched versions of the components may result in unpredictable behavior or errors. It is strongly advised to use the latest compatible versions of all components to ensure proper functionality.
For retrieving firmware versions from TROPIC01 and updating its firmware, refer to the Tutorials and select your platform. Follow the instructions for Chip Identification and Firmware Update example.
CMakeLists.txtRoot CMake project filecmake/CMake related filescal/Implementation of Crypto Abstraction Layers (CAL) for supported Cryptographic Functionality Providers (CFP)docs/MkDocs Documentation deployed hereexamples/Example projects for each supported platformhal/Implementation of Hardware Abstraction Layers (HAL) for supported host platformsinclude/Public API header filesscripts/Build and config scriptssrc/Library's source filestests/Functional testsTROPIC01_fw_update_files/Files used for updating TROPIC01's firmwarevendor/Third party libraries and tools
We provide the FAQ section in our documentation with frequently asked questions and troubleshooting tips.
See the LICENSE.md file in the root of this repository or consult license information at Tropic Square website.