Skip to content

Commit 097c447

Browse files
committed
doc: cracen: add doxygen docs to cracenpsa headers
Added doxygen API documentation to headers under cracenpsa/include. NCSDK-33026. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent f3e720e commit 097c447

18 files changed

+2043
-131
lines changed

doc/nrf/nrf.doxyfile.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -963,6 +963,8 @@ INPUT = @DOCSET_SOURCE_BASE@/applications \
963963
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_key_derivation.h \
964964
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_primitives.h \
965965
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/nrf_security_api_structure.h \
966+
@DOCSET_SOURCE_BASE@/subsys/nrf_security/src/drivers/cracen/cracenpsa/include \
967+
@DOCSET_SOURCE_BASE@/subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h \
966968
@DOCSET_SOURCE_BASE@/subsys/trusted_storage/include/psa \
967969

968970
# This tag can be used to specify the character encoding of the source files

doc/nrf/security/crypto/drivers.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,3 +446,56 @@ API documentation
446446
| Header files: :file:`subsys/nrf_security/include/psa/crypto_driver_contexts_*.h`
447447
448448
.. doxygengroup:: nrf_security_api_structures
449+
450+
CRACEN driver API
451+
=================
452+
453+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa.h`
454+
455+
.. doxygengroup:: cracen_psa_driver_api
456+
457+
CRACEN Key Management Unit (KMU)
458+
==================================
459+
460+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_kmu.h`
461+
462+
.. doxygengroup:: cracen_psa_kmu
463+
464+
CRACEN driver internal API
465+
===========================
466+
467+
| Header files: Internal implementation headers in :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/`
468+
469+
.. note::
470+
These APIs are for internal use only. Applications should use the PSA Crypto API
471+
(``psa_*`` functions) instead of calling these functions directly.
472+
473+
.. doxygengroup:: cracen_psa_driver_internal
474+
475+
CRACEN built-in key policy
476+
===========================
477+
478+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_builtin_key_policy.h`
479+
480+
.. doxygengroup:: cracen_psa_builtin_key_policy
481+
482+
CRACEN key IDs
483+
==============
484+
485+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_key_ids.h`
486+
487+
.. doxygengroup:: cracen_psa_key_ids
488+
489+
CRACEN PSA primitives
490+
=====================
491+
492+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_primitives.h`
493+
494+
.. doxygengroup:: cracen_psa_primitives
495+
496+
SX status codes
497+
===============
498+
499+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h`
500+
501+
.. doxygengroup:: status_codes

subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
#define CRACEN_STATUSCODES_HEADER_FILE
99

1010
/**
11-
* @addtogroup
11+
* @defgroup status_codes SX Status Codes
12+
* @brief SX status code definitions.
1213
*
1314
* @{
1415
*/

0 commit comments

Comments
 (0)