| Archana | 1f1a34a | 2021-11-17 08:44:07 +0530 | [diff] [blame] | 1 | Migrating to an auto genrated psa_crypto_driver_wrappers.c file |
| 2 | =============================================================== |
| 3 | |
| 4 | **This is a specification of work in progress. The implementation is not yet merged into Mbed TLS.** |
| 5 | |
| 6 | This document describes how to migrate to the auto generated psa_crypto_driver_wrappers.c file. |
| 7 | It is meant to give the library user migration guidelines while the Mbed TLS project tides over multiple minor revs of version 1.0, after which this will be merged into psa-driver-interface.md. |
| 8 | |
| 9 | ## Introduction |
| 10 | |
| 11 | The design of the Driver Wrappers code generation is based on the design proposal https://github.com/ARMmbed/mbedtls/pull/5067 |
| 12 | During the process of implementation there might be minor variations wrt versioning and broader implementation specific ideas, but the design remains the same. |
| 13 | |
| 14 | ## Prerequisites |
| 15 | |
| 16 | Python3 and Jinja2 rev 2.10.1 |
| 17 | |
| 18 | ## Feature Version |
| 19 | |
| 20 | 1.0 |
| 21 | |
| 22 | ### What's critical for a migrating user |
| 23 | |
| 24 | The Driver Wrapper auto generation project is designed to use a python templating library ( Jinja2 ) to render templates based on drivers that are defined using a Driver descrioption JSON file(s). |
| 25 | |
| 26 | While that is the larger goal, for version 1.0 here's what's changed |
| 27 | |
| 28 | #### What's changed |
| 29 | |
| 30 | (1) psa_crypto_driver_wrappers.c will from this point on be auto generated. |
| Archana | a8939b6 | 2021-11-23 11:23:01 +0530 | [diff] [blame] | 31 | (2) The auto generation is based on the template file at scripts/data_files/driver_templates/psa_crypto_driver_wrappers.conf. |
| Archana | 1f1a34a | 2021-11-17 08:44:07 +0530 | [diff] [blame] | 32 | (3) So while all driver wrapper templating support is yet to come in, the library user will need to patch into the template file as needed. |