Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions crypto/doc/nrf_cc3xx_mbedcrypto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The nrf_cc3xx_mbedcrypto library provides low-level integration with the Mbed TL
Some of the APIs expressed in this library use the Mbed TLS "alternative implementation" abstraction layer.

.. note::
It is not recommended to link to this library directly. Use the :ref:`nrf_security`.
It is not recommended to link to this library directly. Use the :ref:`nrf:nrf_security`.


Supported cryptographic algorithms
Expand Down Expand Up @@ -134,7 +134,7 @@ Otherwise, the library will default to use the clib functions :c:func:`calloc` a
PSA driver integration
======================
Starting from version 0.9.13, the nrf_oberon library contains a companion library that provides PSA driver integration for select features.
This must be used with the :ref:`nrf_security`.
This must be used with the :ref:`nrf:nrf_security`.

Supported features
------------------
Expand Down
4 changes: 2 additions & 2 deletions crypto/doc/nrf_oberon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The library does not require any initialization before the APIs can be used, alt
Mbed TLS integration
====================
Starting from version 3.0.5, the nrf_oberon library contains a companion library that provides Mbed TLS integration for select features.
This must be used with the :ref:`nrf_security`.
This must be used with the :ref:`nrf:nrf_security`.


Supported features
Expand All @@ -55,7 +55,7 @@ The supported features for the Mbed TLS companion library are:
PSA driver integration
======================
Starting from version 3.0.9, the nrf_oberon library contains a companion library that provides PSA driver integration for select features.
This must be used with the :ref:`nrf_security`.
This must be used with the :ref:`nrf:nrf_security`.

Supported features
------------------
Expand Down
11 changes: 10 additions & 1 deletion crypto/nrf_oberon/include/ocrypto_ecdsa_p521.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@
*/


/**@file
/**
* @file
* @defgroup ocrypto_ecdsa_p521 ECDSA secp521r1 low-level APIs
* @ingroup ocrypto_ecdsa
* @{
* @brief Type declarations and APIs to do Elliptic Curve Digital Signature Algorithm using the
* NIST secp521r1 curve.
*
* ECDSA P-521 is a specific implementation of a digital signature scheme.
*/

Expand Down Expand Up @@ -127,6 +134,8 @@ int ocrypto_ecdsa_p521_verify_hash(
const uint8_t pk[132]);


/** @} */

#ifdef __cplusplus
}
#endif
Expand Down
2 changes: 1 addition & 1 deletion lc3/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Low Complexity Communication Codec (LC3)
:depth: 2

Low Complexity Communication Codec (LC3) is the default software codec for the nRF5340 Audio application, conformant to the `Bluetooth® LE Audio specifications`_ (Bluetooth 5.2).
For more information about the codec usage in the application, see the :ref:`application documentation page <nrf53_audio_app>`.
For more information about the codec usage in the application, see the :ref:`application documentation page <nrf:nrf53_audio_app>`.

The nrfxlib module includes the :file:`lc3/include/sw_codec_lc3.h` and :file:`lc3/src/sw_codec_lc3.c` files that form a translation layer for using a standardized API in the nRF5340 Audio application.

Expand Down
8 changes: 4 additions & 4 deletions mpsl/doc/cx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Selecting CX Implementation
***************************

The :ref:`mpsl` itself does not provide any implementation of the CX interface.
For details on the implementations present in the |NCS|, see :ref:`ug_radio_coex`.
For details on the implementations present in the |NCS|, see :ref:`nrf:ug_radio_coex`.
An application that needs to use CX must call :c:func:`mpsl_cx_interface_set()` during the system initialization.
The initialization of any resource needed by the selected CX implementation is not in scope of :ref:`mpsl` and must also be done during the system initialization.

.. note::
In the |NCS|, the selection of a CX implementation and its appropriate initialization is done automatically, using Kconfig and Device Tree configuration options.
Please refer to :ref:`ug_radio_coex`.
Please refer to :ref:`nrf:ug_radio_coex`.

Using CX API in a protocol driver
*********************************
Expand All @@ -51,5 +51,5 @@ To use the CX API in a protocol driver, you must follow the :ref:`MPSL CX API <m
Implementing CX API
*******************

For details on the implementations of the MPSL CX API for certain PTAs already supported by the |NCS|, see :ref:`ug_radio_coex_mpsl_cx_based`.
If your PTA is not supported yet, see :ref:`ug_radio_mpsl_cx_custom` for guidelines on how to add your own implementation.
For details on the implementations of the MPSL CX API for certain PTAs already supported by the |NCS|, see :ref:`nrf:ug_radio_coex`.
If your PTA is not supported yet, see :ref:`nrf:ug_radio_mpsl_cx_custom` for guidelines on how to add your own implementation.
4 changes: 2 additions & 2 deletions nrf_802154/doc/rd_limitations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Limitations
###########

When working with the nRF 802.15.4 Radio Driver, you should be aware of the following limitations.
In addition, see :ref:`known_issues` for temporary issues that will be fixed in future releases.
In addition, see :ref:`nrf:known_issues` for temporary issues that will be fixed in future releases.

IRQ priority limitations
Application and device drivers (excluding those compliant with :ref:`mpsl`) must not use IRQ priority higher than :c:macro:`NRF_802154_SWI_PRIORITY` and :c:macro:`NRF_802154_SL_RTC_IRQ_PRIORITY`.
Expand All @@ -13,4 +13,4 @@ KRKNWK-11204: Transmitting an 802.15.4 frame with improperly populated Auxiliary
**Workaround:** Make sure that you populate the Auxiliary Security Header field according to the IEEE Std 802.15.4-2015 specification, section 9.4.

KRKNWK-12482: Reception of correct frames will occasionally end in failure with error ``NRF_802154_RX_ERROR_RUNTIME``
This issue can occur for the ``nrf5340dk_nrf5340_cpunet`` target if a custom application (other than :ref:`multiprotocol-rpmsg-sample` sample or :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample) is used.
This issue can occur for the ``nrf5340dk_nrf5340_cpunet`` target if a custom application (other than :ref:`nrf:multiprotocol-rpmsg-sample` sample or :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample) is used.
8 changes: 4 additions & 4 deletions nrf_modem/doc/at_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -346,13 +346,13 @@ The following snippet shows how to setup an AT notification handler:
The callback is invoked in an interrupt context.
The user is responsible for rescheduling the processing of AT notifications as appropriate.

In |NCS|, the :ref:`at_monitor_readme` library takes care of dispatching notifications to different parts of the application.
In |NCS|, the :ref:`nrf:at_monitor_readme` library takes care of dispatching notifications to different parts of the application.

.. important::
In |NCS| applications, many libraries use the :ref:`at_monitor_readme` library to register their own callback with the Modem library using the :c:func:`nrf_modem_at_notif_handler_set` function.
In |NCS| applications, many libraries use the :ref:`nrf:at_monitor_readme` library to register their own callback with the Modem library using the :c:func:`nrf_modem_at_notif_handler_set` function.
If you are building an |NCS| application, do not use the :c:func:`nrf_modem_at_notif_handler_set` function to register your callback.
Instead, use the :ref:`at_monitor_readme` library to dispatch AT notifications to where you need them in your application, and to ensure compatibility with other |NCS| libraries.
The :ref:`at_monitor_readme` library also takes care of rescheduling the notifications to a thread context.
Instead, use the :ref:`nrf:at_monitor_readme` library to dispatch AT notifications to where you need them in your application, and to ensure compatibility with other |NCS| libraries.
The :ref:`nrf:at_monitor_readme` library also takes care of rescheduling the notifications to a thread context.

Thread safety
*************
Expand Down
4 changes: 2 additions & 2 deletions nrf_modem/doc/fault_handling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When the modem crashes, the modem fault handler set by the application is called
In some cases, the modem fault handler also contains information about the program counter of the modem.
For a complete list of the modem fault reasons, see :ref:`nrf_modem_fault_api_reasons`.

In |NCS|, the :ref:`nrf_modem_lib_readme` sets the modem fault handler during Modem library initialization.
In |NCS|, the :ref:`nrf:nrf_modem_lib_readme` sets the modem fault handler during Modem library initialization.

Recovering from a fault
***********************
Expand All @@ -38,7 +38,7 @@ The application can reinitialize the modem by reinitializing the Modem library t
To make sure the application is able to retrieve the coredump correctly, the application must not re-initialize the modem until all the outstanding trace data has been processed.
The :c:func:`nrf_modem_trace_get` function returns ``-NRF_ENODATA`` when all outstanding trace data has been processed by the application.

When the Modem library is used in |NCS|, the :ref:`nrf_modem_lib_readme` handles synchronizing modem re-initialization with tracing operations.
When the Modem library is used in |NCS|, the :ref:`nrf:nrf_modem_lib_readme` handles synchronizing modem re-initialization with tracing operations.

Networking sockets
******************
Expand Down
4 changes: 2 additions & 2 deletions nrf_modem/doc/gnss_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ If the fix retry parameter is set to zero, GNSS is allowed to run indefinitely u
.. note::

Unless disabled using the :c:func:`nrf_modem_gnss_use_case_set` function, GNSS performs :term:`Scheduled downloads` in periodic navigation mode.
Unless disabled using the :c:func:`nrf_modem_gnss_use_case_set` function, GNSS performs :term:`nrf:Scheduled downloads` in periodic navigation mode.
During a scheduled download, the fix interval and fix retry parameters are temporarily ignored.
After GNSS has downloaded the data it needs, normal operation is resumed.

Expand Down Expand Up @@ -483,7 +483,7 @@ A-GNSS data
***********

You can use GNSS assistance data to shorten TTFF and decrease GNSS power consumption.
See :ref:`lib_nrf_cloud_agps` and :ref:`lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`lib_nrf_cloud` to be used with the nRF91 Series SiPs.
See :ref:`nrf:lib_nrf_cloud_agps` and :ref:`nrf:lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`nrf:lib_nrf_cloud` to be used with the nRF91 Series SiPs.

.. _gnss_int_assistance_need:

Expand Down
4 changes: 2 additions & 2 deletions nrf_modem/doc/modem_trace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Modem traces
The modem trace APIs in the Modem library are used to retrieve binary trace data from the modem core.
The application is responsible for forwarding the trace data to a host computer, where it can be collected with the `Cellular Monitor`_ PC tool to extract PCAP data, or to save them to file for further inspection by Nordic Semiconductor.

In the |NCS|, the :ref:`nrf_modem_lib_readme` takes care of retrieving and forwarding the trace data, for example to a computer or to a non-volatile memory.
In the |NCS|, the :ref:`nrf:nrf_modem_lib_readme` takes care of retrieving and forwarding the trace data, for example to a computer or to a non-volatile memory.

Enabling modem traces
*********************
Expand All @@ -20,7 +20,7 @@ To enable traces the application must initialize the Modem library with a non-ze
The trace output from the modem can be toggled at runtime using the AT command ``%XMODEMTRACE``, which can also be used to change the trace output level.
For more information, see the `Modem trace activation %XMODEMTRACE`_ section in the nRF9160 AT Commands Reference Guide or the `same section <nRF91x1 modem trace activation %XMODEMTRACE_>`_ in the nRF91x1 AT Commands Reference Guide, depending on the SiP you are using.

In the |NCS|, the :ref:`nrf_modem_lib_readme` offers a dedicated function to simplify the task of enabling and disabling the trace output, and setting the trace level.
In the |NCS|, the :ref:`nrf:nrf_modem_lib_readme` offers a dedicated function to simplify the task of enabling and disabling the trace output, and setting the trace level.

Fetching modem traces
*********************
Expand Down
2 changes: 1 addition & 1 deletion nrf_modem/doc/sockets/pdn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To configure PDP contexts and activate PDN connections, the application must use
When performing network operations on any PDN, the application ensures that the PDN connection is available.
For more information about how to configure PDP contexts, activate PDN connections, and determine their state, see the `Packet domain commands`_ section in the nRF9160 AT Commands Reference Guide or the same section in the `nRF91x1 AT Commands Reference Guide`_ depending on the SiP you are using.

Alternatively, the :ref:`pdn_readme` library in |NCS| can be used to receive events on PDN connectivity and manage packet data networks.
Alternatively, the :ref:`nrf:pdn_readme` library in |NCS| can be used to receive events on PDN connectivity and manage packet data networks.


Configuring a socket to use a PDN
Expand Down
2 changes: 1 addition & 1 deletion openthread/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ OpenThread pre-built libraries
The |NCS| provides pre-built OpenThread libraries.
Some of these are certified by the Thread Group for use with Nordic Semiconductor devices.
This simplifies the OpenThread certification process of the final product.
See :ref:`ug_thread_cert` for more information.
See :ref:`nrf:ug_thread_cert` for more information.

The pre-built libraries vary depending on stack configuration and hardware cryptography capabilities:

Expand Down
2 changes: 1 addition & 1 deletion softdevice_controller/doc/scheduling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Here :math:`\mathsf{C1}` can utilize the free time left by a previously disconne
Multilink scheduling and Connection Event Length Extension

Scanner and Initiator timing
************************
****************************

Scanning is a periodic activity where the |controller| listens for packets from Advertisers.
Initiating is a periodic activity where the |controller| tries to connect to an Advertiser by first listening for packets from an Advertiser.
Expand Down
2 changes: 1 addition & 1 deletion softdevice_controller/limitations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ DRGN-6362: Synthesized low frequency clock source not tested
DRGN-12259: HCI Receiver and Transmitter Test commands not available
The HCI Receiver and Transmitter Test commands are not available.

**Workaround:** To perform a radio test, use the :ref:`direct_test_mode` sample.
**Workaround:** To perform a radio test, use the :ref:`nrf:direct_test_mode` sample.
For nRF52 Series devices, you can choose to use the DTM application in the nRF5 SDK instead.

DRGN-15989: In some cases, the SDC can connect to the peer it is already connected to
Expand Down
Loading