yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Change comments to psa_crypto_driver_wrappers.h

Browse source 
Signed-off-by: Xiaokang Qian <xiaokang.qian@arm.com>
This commit is contained in:
Xiaokang Qian 2023-09-12 03:14:54 +00:00
parent fe9666b8c0
commit 845693c513
5 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/architecture/psa-crypto-implementation-structure.md
View file

@ -49,7 +49,7 @@ psa_status_t psa_api( ... )
``` ```
The code of most PSA APIs is expected to match precisely the above layout. However, it is likely that the code structure of some APIs will be more complicated with several calls to the driver interface, mainly to encompass a larger variety of hardware designs. For example, to encompass hardware accelerators that are capable of verifying a MAC and those that are only capable of computing a MAC, the psa_mac_verify() API could call first psa_driver_wrapper_mac_verify() and then fallback to psa_driver_wrapper_mac_compute(). The code of most PSA APIs is expected to match precisely the above layout. However, it is likely that the code structure of some APIs will be more complicated with several calls to the driver interface, mainly to encompass a larger variety of hardware designs. For example, to encompass hardware accelerators that are capable of verifying a MAC and those that are only capable of computing a MAC, the psa_mac_verify() API could call first psa_driver_wrapper_mac_verify() and then fallback to psa_driver_wrapper_mac_compute().
The implementations of `psa_driver_wrapper_<entry_point>` functions are generated by the build system based on the JSON driver description files of the various PSA drivers making up the Mbed TLS PSA Cryptography API implementation. The implementations are generated in a psa_crypto_driver_wrappers.c C file and the function prototypes declared in a psa_crypto_driver_wrappers.h header file. The implementations of `psa_driver_wrapper_<entry_point>` functions are generated by the build system based on the JSON driver description files of the various PSA drivers making up the Mbed TLS PSA Cryptography API implementation. The implementations are generated in a psa_crypto_driver_wrappers.c C file and the function prototypes declared in a psa_crypto_driver_wrappers_no_static.h header file.
The psa_driver_wrapper_<entry_point>() functions dispatch cryptographic operations to accelerator drivers, secure element drivers as well as to the software implementations of cryptographic operations. The psa_driver_wrapper_<entry_point>() functions dispatch cryptographic operations to accelerator drivers, secure element drivers as well as to the software implementations of cryptographic operations.

2
include/psa/crypto_driver_contexts_composites.h
View file

@ -121,7 +121,7 @@ typedef mbedtls_psa_pake_operation_t
* *
* The union members are the driver's context structures, and the member names * The union members are the driver's context structures, and the member names
* are formatted as `'drivername'_ctx`. This allows for procedural generation * are formatted as `'drivername'_ctx`. This allows for procedural generation
* of both this file and the content of psa_crypto_driver_wrappers.c */ * of both this file and the content of psa_crypto_driver_wrappers.h */
typedef union { typedef union {
unsigned dummy; /* Make sure this union is always non-empty */ unsigned dummy; /* Make sure this union is always non-empty */

2
include/psa/crypto_driver_contexts_primitives.h
View file

@ -94,7 +94,7 @@ typedef struct {
* *
* The union members are the driver's context structures, and the member names * The union members are the driver's context structures, and the member names
* are formatted as `'drivername'_ctx`. This allows for procedural generation * are formatted as `'drivername'_ctx`. This allows for procedural generation
* of both this file and the content of psa_crypto_driver_wrappers.c */ * of both this file and the content of psa_crypto_driver_wrappers.h */
typedef union { typedef union {
unsigned dummy; /* Make sure this union is always non-empty */ unsigned dummy; /* Make sure this union is always non-empty */

3
library/.gitignore vendored
View file

@ -6,5 +6,6 @@ libmbed*
/error.c /error.c
/version_features.c /version_features.c
/ssl_debug_helpers_generated.c /ssl_debug_helpers_generated.c
/psa_crypto_driver_wrappers.c /psa_crypto_driver_wrappers.h
/psa_crypto_driver_wrappers_no_static.c
###END_GENERATED_FILES### ###END_GENERATED_FILES###

2
scripts/make_generated_files.bat
View file

@ -1,7 +1,7 @@
@rem Generate automatically-generated configuration-independent source files @rem Generate automatically-generated configuration-independent source files
@rem and build scripts. @rem and build scripts.
@rem Perl and Python 3 must be on the PATH. @rem Perl and Python 3 must be on the PATH.
@rem psa_crypto_driver_wrappers.c needs to be generated prior to @rem psa_crypto_driver_wrappers.h needs to be generated prior to
@rem generate_visualc_files.pl being invoked. @rem generate_visualc_files.pl being invoked.
python scripts\generate_driver_wrappers.py || exit /b 1 python scripts\generate_driver_wrappers.py || exit /b 1
perl scripts\generate_errors.pl || exit /b 1 perl scripts\generate_errors.pl || exit /b 1