Skip to content

Commit 35b44a7

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 35b44a7

19 files changed

+2078
-132
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/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ Security
120120
The algorithm implementation is conformant to the NIST SP 800-108 Rev. 1 recommendation.
121121
* Support for the secp384r1 key storage in the :ref:`Key Management Unit (KMU) <ug_nrf54l_crypto_kmu_supported_key_types>`.
122122

123+
* Updated the :ref:`API documentation section for the cryptographic drivers <crypto_drivers_api_documentation>` with links to the added API documentation for the CRACEN driver.
124+
123125
Protocols
124126
=========
125127

@@ -437,7 +439,9 @@ Gazell libraries
437439
Security libraries
438440
------------------
439441

440-
|no_changes_yet_note|
442+
* :ref:`nrf_security` library:
443+
444+
* Updated the header files at :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/` with Doxygen documentation.
441445

442446
Modem libraries
443447
---------------

doc/nrf/security/crypto/drivers.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,9 +440,64 @@ For configuration details, see the following pages:
440440
* :ref:`psa_crypto_support`
441441
* :ref:`nrf_security_legacy_backend_config` (nrf_oberon used as legacy backend)
442442

443+
.. _crypto_drivers_api_documentation:
444+
443445
API documentation
444446
*****************
445447

446448
| Header files: :file:`subsys/nrf_security/include/psa/crypto_driver_contexts_*.h`
447449
448450
.. doxygengroup:: nrf_security_api_structures
451+
452+
CRACEN driver API
453+
=================
454+
455+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa.h`
456+
457+
.. doxygengroup:: cracen_psa_driver_api
458+
459+
CRACEN Key Management Unit (KMU)
460+
================================
461+
462+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_kmu.h`
463+
464+
.. doxygengroup:: cracen_psa_kmu
465+
466+
CRACEN driver internal API
467+
==========================
468+
469+
| Header files: Internal implementation headers in :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/`
470+
471+
.. note::
472+
These APIs are for internal use only. Applications should use the PSA Crypto API
473+
(``psa_*`` functions) instead of calling these functions directly.
474+
475+
.. doxygengroup:: cracen_psa_driver_internal
476+
477+
CRACEN built-in key policy
478+
==========================
479+
480+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_builtin_key_policy.h`
481+
482+
.. doxygengroup:: cracen_psa_builtin_key_policy
483+
484+
CRACEN key IDs
485+
==============
486+
487+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_key_ids.h`
488+
489+
.. doxygengroup:: cracen_psa_key_ids
490+
491+
CRACEN PSA primitives
492+
=====================
493+
494+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_primitives.h`
495+
496+
.. doxygengroup:: cracen_psa_primitives
497+
498+
SX status codes
499+
===============
500+
501+
| Header files: :file:`subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h`
502+
503+
.. 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)