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

greg-fer · 2026-01-08T12:08:08Z

Added doxygen API documentation to headers under cracenpsa/include. NCSDK-33026.

Copilot

Pull request overview

This PR adds comprehensive Doxygen API documentation to the CRACEN PSA driver header files, improving code documentation and enabling automated API reference generation.

Key changes:

Added file-level Doxygen documentation headers to all CRACEN PSA include files
Documented all public function APIs with parameter descriptions and return values
Created Doxygen groups for major subsystems (KMU, IKG)
Integrated CRACEN driver documentation into the nRF documentation build system

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
cracen_psa_wpa3_sae.h	Added Doxygen docs for WPA3 SAE operations
cracen_psa_rsa_signature_pss.h	Added Doxygen docs for RSA PSS signature functions
cracen_psa_rsa_signature_pkcs1v15.h	Added Doxygen docs for RSA PKCS#1 v1.5 signature functions
cracen_psa_rsa_keygen.h	Added Doxygen docs for RSA key generation
cracen_psa_rsa_encryption.h	Added Doxygen docs for RSA encryption operations
cracen_psa_montgomery.h	Added Doxygen docs for Montgomery curve operations
cracen_psa_mac_kdf.h	Added Doxygen docs for MAC and KDF definitions
cracen_psa_kmu.h	Added Doxygen group and comprehensive docs for KMU API
cracen_psa_key_ids.h	Added Doxygen docs for key ID definitions
cracen_psa_ikg.h	Added Doxygen group and docs for IKG API
cracen_psa_eddsa.h	Added Doxygen docs for EdDSA operations
cracen_psa_ecdsa.h	Added Doxygen docs for ECDSA operations
cracen_psa_builtin_key_policy.h	Added Doxygen docs for built-in key policy structures
cracen_psa.h	Added Doxygen group and extensive docs for main driver API
drivers.rst	Added CRACEN driver API documentation sections
nrf.doxyfile.in	Included CRACEN header directory in Doxygen input

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_wpa3_sae.h

NordicBuilder · 2026-01-08T12:11:58Z

CI Information

^{To view the history of this post, click the 'edited' button above}
Build number: 11

Inputs:

Sources:

sdk-nrf: PR head: 9a0045d274aab14877a91331e20a36c18b70dd9d

more details

sdk-nrf:

PR head: 9a0045d274aab14877a91331e20a36c18b70dd9d
merge base: f3e720ea6a4ce12cfefe1cabde659c54997cf8d4
target head (main): 69b449deef77c1c56510a8caada06b3e374e6668
Diff

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (20)

doc
│  ├── nrf
│  │  ├── nrf.doxyfile.in
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst
│  │  ├── security
│  │  │  ├── crypto
│  │  │  │  │ drivers.rst
subsys
│  ├── nrf_security
│  │  ├── src
│  │  │  ├── drivers
│  │  │  │  ├── cracen
│  │  │  │  │  ├── common
│  │  │  │  │  │  ├── include
│  │  │  │  │  │  │  ├── cracen
│  │  │  │  │  │  │  │  │ statuscodes.h
│  │  │  │  │  ├── cracenpsa
│  │  │  │  │  │  ├── include
│  │  │  │  │  │  │  ├── cracen_psa.h
│  │  │  │  │  │  │  ├── cracen_psa_api_structure.h
│  │  │  │  │  │  │  ├── cracen_psa_builtin_key_policy.h
│  │  │  │  │  │  │  ├── cracen_psa_ecdsa.h
│  │  │  │  │  │  │  ├── cracen_psa_eddsa.h
│  │  │  │  │  │  │  ├── cracen_psa_ikg.h
│  │  │  │  │  │  │  ├── cracen_psa_key_ids.h
│  │  │  │  │  │  │  ├── cracen_psa_kmu.h
│  │  │  │  │  │  │  ├── cracen_psa_mac_kdf.h
│  │  │  │  │  │  │  ├── cracen_psa_montgomery.h
│  │  │  │  │  │  │  ├── cracen_psa_primitives.h
│  │  │  │  │  │  │  ├── cracen_psa_rsa_encryption.h
│  │  │  │  │  │  │  ├── cracen_psa_rsa_keygen.h
│  │  │  │  │  │  │  ├── cracen_psa_rsa_signature_pkcs1v15.h
│  │  │  │  │  │  │  ├── cracen_psa_rsa_signature_pss.h
│  │  │  │  │  │  │  │ cracen_psa_wpa3_sae.h

Outputs:

Toolchain

Version: 400c6cb4ec
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:400c6cb4ec_5ea73affbf

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain - Skipped: existing toolchain is used
✅ Build twister
- sdk-nrf test count: 2602
✅ Integration tests
- ✅ test_ble_nrf_config
- ✅ test-fw-nrfconnect-chip
- ✅ test-fw-nrfconnect-nrf-iot_cloud
- ✅ test-fw-nrfconnect-nrf_crypto
- ✅ test-fw-nrfconnect-rs
- ✅ test-fw-nrfconnect-tfm
- ✅ test-sdk-find-my
- ✅ test-sdk-mcuboot
- ✅ test-sdk-dfu

Disabled integration tests

- test-fw-nrfconnect-nrf_lrcs_mosh
- desktop52_verification
- test-fw-nrfconnect-ble_mesh
- test-fw-nrfconnect-ble_samples
- test-fw-nrfconnect-fem
- test-fw-nrfconnect-nfc
- test-fw-nrfconnect-nrf-iot_libmodem-nrf
- test-fw-nrfconnect-nrf-iot_lwm2m
- test-fw-nrfconnect-nrf-iot_samples
- test-fw-nrfconnect-nrf-iot_thingy91
- test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
- test-fw-nrfconnect-ps-main
- test-fw-nrfconnect-rpc
- test-fw-nrfconnect-thread-main
- test-low-level
- test-sdk-audio
- test-sdk-wifi
- test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

degjorva

Amazing! This is just some quick initial comments after skimming through it. I will give it the proper deep read it deserves later

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_ecdsa.h

github-actions · 2026-01-08T12:40:58Z

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-26438/nrf/releases_and_maturity/releases/release-notes-changelog.html
https://ncsdoc.z6.web.core.windows.net/PR-26438/nrf/security/crypto/drivers.html

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

degjorva

I read through ECDSA and gave some suggestions on updates there

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_ecdsa.h

Copilot

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_rsa_signature_pkcs1v15.h

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_wpa3_sae.h

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa.h

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_wpa3_sae.h

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_rsa_encryption.h

Added doxygen API documentation to headers under cracenpsa/include. NCSDK-33026. Signed-off-by: Grzegorz Ferenc <[email protected]>

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-09T14:44:35Z

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


 /**
- * @addtogroup
+ * @defgroup status_codes SX Status Codes


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

greg-fer requested review from AntonZma, Copilot, degjorva and frkv January 8, 2026 12:08

NordicBuilder added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 8, 2026

Copilot AI reviewed Jan 8, 2026

View reviewed changes

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_wpa3_sae.h Outdated Show resolved Hide resolved

degjorva reviewed Jan 8, 2026

View reviewed changes

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_ecdsa.h Outdated Show resolved Hide resolved

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_ecdsa.h Show resolved Hide resolved

greg-fer force-pushed the doc_cracenpsa_doxygen branch from a08ab39 to b202b83 Compare January 8, 2026 13:20

Copilot AI review requested due to automatic review settings January 8, 2026 14:26

greg-fer force-pushed the doc_cracenpsa_doxygen branch from b202b83 to 4278215 Compare January 8, 2026 14:26

Copilot AI reviewed Jan 8, 2026

View reviewed changes

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 4278215 to 92cf118 Compare January 8, 2026 15:01

Copilot AI review requested due to automatic review settings January 8, 2026 15:27

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 92cf118 to 097c447 Compare January 8, 2026 15:27

Copilot AI reviewed Jan 8, 2026

View reviewed changes

degjorva reviewed Jan 9, 2026

View reviewed changes

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 097c447 to 9f0e2b7 Compare January 9, 2026 09:36

NordicBuilder removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 9, 2026

Copilot AI review requested due to automatic review settings January 9, 2026 11:11

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 9f0e2b7 to 35b44a7 Compare January 9, 2026 11:11

Copilot AI reviewed Jan 9, 2026

View reviewed changes

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 35b44a7 to 7c7329d Compare January 9, 2026 11:42

Copilot AI review requested due to automatic review settings January 9, 2026 12:26

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 7c7329d to 1a8052f Compare January 9, 2026 12:26

Copilot AI reviewed Jan 9, 2026

View reviewed changes

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_wpa3_sae.h Show resolved Hide resolved

subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_rsa_encryption.h Show resolved Hide resolved

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 1a8052f to 8e2fbd3 Compare January 9, 2026 14:40

doc: cracen: add doxygen docs to cracenpsa headers

9a0045d

Added doxygen API documentation to headers under cracenpsa/include. NCSDK-33026. Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer force-pushed the doc_cracenpsa_doxygen branch from 8e2fbd3 to 9a0045d Compare January 9, 2026 14:43

Copilot AI review requested due to automatic review settings January 9, 2026 14:43

greg-fer marked this pull request as ready for review January 9, 2026 14:43

greg-fer requested a review from Copilot January 9, 2026 14:43

greg-fer requested review from a team as code owners January 9, 2026 14:43

Copilot AI reviewed Jan 9, 2026

View reviewed changes

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

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

greg-fer commented Jan 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

NordicBuilder commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

Uh oh!

degjorva left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

degjorva left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

NordicBuilder commented Jan 8, 2026 •

edited

Loading

github-actions bot commented Jan 8, 2026 •

edited

Loading