Skip to content

doc: cracen: add doxygen docs to cracenpsa headers #26438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
greg-fer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: cracen: add doxygen docs to cracenpsa headers #26438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/nrf/nrf.doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,6 +963,8 @@ INPUT = @DOCSET_SOURCE_BASE@/applications \
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_key_derivation.h \
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_primitives.h \
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/nrf_security_api_structure.h \
@DOCSET_SOURCE_BASE@/subsys/nrf_security/src/drivers/cracen/cracenpsa/include \
@DOCSET_SOURCE_BASE@/subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h \
@DOCSET_SOURCE_BASE@/subsys/trusted_storage/include/psa \

# This tag can be used to specify the character encoding of the source files
Expand Down
6 changes: 5 additions & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ Security
The algorithm implementation is conformant to the NIST SP 800-108 Rev. 1 recommendation.
* Support for the secp384r1 key storage in the :ref:`Key Management Unit (KMU) <ug_nrf54l_crypto_kmu_supported_key_types>`.

* 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.

Protocols
=========

Expand Down Expand Up @@ -437,7 +439,9 @@ Gazell libraries
Security libraries
------------------

|no_changes_yet_note|
* :ref:`nrf_security` library:

* Updated the header files at :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/` with Doxygen documentation.

Modem libraries
---------------
Expand Down
16 changes: 16 additions & 0 deletions doc/nrf/security/crypto/drivers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,9 +440,25 @@ For configuration details, see the following pages:
* :ref:`psa_crypto_support`
* :ref:`nrf_security_legacy_backend_config` (nrf_oberon used as legacy backend)

.. _crypto_drivers_api_documentation:

API documentation
*****************

| Header files: :file:`subsys/nrf_security/include/psa/crypto_driver_contexts_*.h`

.. doxygengroup:: nrf_security_api_structures

CRACEN driver API
=================

| Header files: :file:`subsys/nrf_security/src/drivers/cracen/cracenpsa/include/`

.. doxygengroup:: cracen_psa_driver_apis

SX status codes
===============

| Header files: :file:`subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h`

.. doxygengroup:: status_codes
3 changes: 2 additions & 1 deletion subsys/nrf_security/src/drivers/cracen/common/include/cracen/statuscodes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
#define CRACEN_STATUSCODES_HEADER_FILE

/**
* @addtogroup
* @defgroup status_codes SX Status Codes
Copy link

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The group name 'status_codes' is generic and could conflict with other documentation groups. Consider using a more specific name like 'cracen_status_codes' or 'sx_status_codes' to avoid potential naming conflicts in the documentation system.

Suggested change
* @defgroup status_codes SX Status Codes
* @defgroup cracen_status_codes SX Status Codes

Copilot uses AI. Check for mistakes.
* @brief SX status code definitions.
*
* @{
*/
Expand Down
Loading
Loading