README for CMSIS-mbedTLS

Introduction

This is a fork of the original mbed TLS. It uses the source files from the mbed TLS repository, and adds capabilities to build a software pack from it. It also contains the complete mbed TLS documentation that is built with Doxygen. This documentation is linked in the PDSC file so that it is easily accessible from development systems with pack support.

Create the software pack

Prerequisites

To build the pack you will need the following software:

• bash compatible shell (under Windows, use for example git bash)
• Python v3.6 or later
• Doxygen 1.8.x to build the documentation
• Graphviz to create graphs in the documentation
• 7-ZIP to create the pack file
• CMSIS Pack installed in CMSIS_PACK_ROOT (for PackChk utility)
• xmllint in path (XML schema validation; available only for Linux)

Build the software pack

To build a software pack, clone the repository or download the ZIP file and save it on your local drive. Open a bash shell and run gen_doc.sh to build the documentation and run gen_pack.sh to build the pack. The resulting software pack will be available in the directory ..\output under the name ARM.mbedTLS.X.X.X.pack. To use it, simply double-click the pack file and it will be added to your development environment's installation.

License

ARM CMSIS-mbedTLS is licensed under Apache-2.0.