doc: Doc fixes for 2.4 release

umapraseeda · de-nordic · commit 8a29f3c4ac33 · 2023-05-24T18:45:23.000+02:00
Doc fixes for 2.4 release

Signed-off-by: Uma Praseeda &lt;uma.praseeda@nordicsemi.no&gt;
diff --git a/README.rst b/README.rst
@@ -19,11 +19,11 @@ Refer to their respective documentation for more information.
    nrf_modem/README
    mpsl/README
    nrf_802154/README
+   nrf_fuel_gauge/README
    nfc/README
    nrf_dm/README
    nrf_security/README
    openthread/README
    nrf_rpc/README
    softdevice_controller/README
    zboss/README
-   nrf_fuel_gauge/README
diff --git a/crypto/doc/nrf_cc310_mbedcrypto.rst b/crypto/doc/nrf_cc310_mbedcrypto.rst
@@ -203,6 +203,12 @@ The library cannot be used in the :ref:`Non-Secure Processing Environment (NSPE)
 The hardware can only process one request at a time.
 Therefore, this library has used mutexes to make the library thread-safe.
 
+On Arm CryptoCell 310 devices (nRF52840 and nRF91 Series), symmetric operations (like hashing and encryption) require data input to be present in DMA acessible RAM.
+
+.. note::
+
+      In Arm CryptoCell 312 devices (nRF5340), there are no restrictions as CryptoCell has DMA access to Flash.
+
 API documentation
 =================
 
diff --git a/crypto/nrf_cc310_mbedcrypto/CHANGELOG.rst b/crypto/nrf_cc310_mbedcrypto/CHANGELOG.rst
diff --git a/crypto/nrf_cc310_platform/CHANGELOG.rst b/crypto/nrf_cc310_platform/CHANGELOG.rst
diff --git a/crypto/nrf_oberon/CHANGELOG.rst b/crypto/nrf_oberon/CHANGELOG.rst
diff --git a/nrf_modem/doc/CHANGELOG.rst b/nrf_modem/doc/CHANGELOG.rst
@@ -17,15 +17,15 @@ nrf_modem 2.4.0
 
 * Added
 
-  * The ``NRF_SO_SEC_DTLS_CID`` and ``NRF_SO_SEC_DTLS_CID_STATUS`` socket options for DTLS connection ID.
-  * The ``NRF_SO_SEC_DTLS_CONN_SAVE`` and ``NRF_SO_SEC_DTLS_CONN_LOAD`` socket options.
-  * The ``NRF_SO_SEC_CIPHERSUITE_USED`` socket option (requires mfw v2.0.0).
-  * The ``NRF_SO_SEC_HANDSHAKE_STATUS`` socket option (requires mfw v2.0.0).
+  * The :c:macro:`NRF_SO_SEC_DTLS_CID` and :c:macro:`NRF_SO_SEC_DTLS_CID_STATUS` socket options for DTLS connection ID.
+  * The :c:macro:`NRF_SO_SEC_DTLS_CONN_SAVE` and :c:macro:`NRF_SO_SEC_DTLS_CONN_LOAD` socket options.
+  * The :c:macro:`NRF_SO_SEC_CIPHERSUITE_USED` socket option (requires modem firmware v2.0.0).
+  * The :c:macro:`NRF_SO_SEC_HANDSHAKE_STATUS` socket option (requires modem firmware v2.0.0).
   * The :c:macro:`NRF_SOCKET_TLS_MAX_SEC_TAG_LIST_SIZE` macro to indicate the maximum number of security tags that can be associated with a socket.
   * Several new macros for allowed TLS/DTLS socket option values.
 
 * Fixed a memory leak in the :c:func:`nrf_getsockopt` function, in certain cases where the function returned an error.
-* The :c:macro:`NRF_MODEM_MAX_SOCKET_COUNT` macro was moved to :file:`nrf_socket.h`, from :file:`nrf_modem.h`.
+* The :c:macro:`NRF_MODEM_MAX_SOCKET_COUNT` macro was moved from :file:`nrf_modem.h` to :file:`nrf_socket.h`.
 
 :ref:`AT interface <nrf_modem_at>`
 ==================================
diff --git a/nrf_modem/doc/at_interface.rst b/nrf_modem/doc/at_interface.rst
@@ -233,7 +233,7 @@ The following is the response format that must be the same as the modem's:
 * Successful responses end with ``OK\r\n``.
 * For error response, use ``ERROR\r\n``, ``+CME ERROR: <errorcode>``, or ``+CMS ERROR: <errorcode>`` depending on the error.
 
-The following snippet shows how to set up and use an custom AT command:
+The following snippet shows how to set up and use a custom AT command:
 
 .. code-block:: c
 
@@ -319,9 +319,9 @@ The user is responsible for rescheduling the processing of AT notifications as a
 In |NCS|, the :ref:`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.
-   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.
+   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.
+   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.
 
 Thread safety
diff --git a/nrf_modem/doc/sockets.rst b/nrf_modem/doc/sockets.rst
@@ -70,7 +70,7 @@ The following table shows all socket options supported by the Modem library.
 +-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
 | NRF_SOL_SECURE  | NRF_SO_SEC_HOSTNAME             | ``char *``             | get/set    | Set/get the hostname to check against during TLS handshakes.                               |
 +-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
-| NRF_SOL_SECURE  | NRF_SO_SEC_CIPHERSUITE_LIST     | ``nrf_sec_cipher_t *`` | get/set    | Set/get allowed ciphersuite list.                                                          |
+| NRF_SOL_SECURE  | NRF_SO_SEC_CIPHERSUITE_LIST     | ``nrf_sec_cipher_t *`` | get/set    | Set/get allowed cipher suite list.                                                         |
 +-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
 | NRF_SOL_SECURE  | NRF_SO_SEC_PEER_VERIFY          | ``nrf_peer_verify_t``  | get/set    | Set/get Peer verification level.                                                           |
 +-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
@@ -108,12 +108,12 @@ The details for each socket are described as follows:
 NRF_SO_ERROR
    When this option is specified, :c:func:`nrf_getsockopt` returns any pending errors on the socket and clears the error status.
    It returns a ``0`` value if there is no pending error.
-   ``NRF_SO_ERROR`` might be used to check for asynchronous errors on connected connectionless-mode sockets or for other types of asynchronous errors.
-   ``NRF_SO_ERROR`` has no default value.
+   :c:macro:`NRF_SO_ERROR` might be used to check for asynchronous errors on connected connectionless-mode sockets or for other types of asynchronous errors.
+   :c:macro:`NRF_SO_ERROR` has no default value.
 
 NRF_SO_REUSEADDR
   Allow for the reuse of local addresses by using the :c:func:`nrf_bind` function.
-  The default value for ``NRF_SO_REUSEADDR`` is ``off``, that is, reuse of local addresses is not permitted.
+  The default value for :c:macro:`NRF_SO_REUSEADDR` is ``off``, that is, reuse of local addresses is not permitted.
 
 NRF_SO_RCVTIMEO
    Set a timeout value for the :c:func:`nrf_recv` and :c:func:`nrf_recvfrom` operations.
@@ -217,18 +217,18 @@ NRF_SO_SEC_PEER_VERIFY
   Set the peer verification level.
   The following values are accepted:
 
-   * ``NRF_SO_SEC_PEER_VERIFY_NONE`` - No peer verification
-   * ``NRF_SO_SEC_PEER_VERIFY_OPTIONAL`` - Optional peer verification
-   * ``NRF_SO_SEC_PEER_VERIFY_REQUIRED`` - Peer verification is required
+   * :c:macro:`NRF_SO_SEC_PEER_VERIFY_NONE` - No peer verification
+   * :c:macro:`NRF_SO_SEC_PEER_VERIFY_OPTIONAL` - Optional peer verification
+   * :c:macro:`NRF_SO_SEC_PEER_VERIFY_REQUIRED` - Peer verification is required
 
    By default, peer verification is required.
 
 NRF_SO_SEC_ROLE
    Set the role for the connection.
    The following values are accepted:
 
-   * ``NRF_SO_SEC_ROLE_CLIENT`` - Client role
-   * ``NRF_SO_SEC_ROLE_SERVER`` - Server role
+   * :c:macro:`NRF_SO_SEC_ROLE_CLIENT` - Client role
+   * :c:macro:`NRF_SO_SEC_ROLE_SERVER` - Server role
 
    The default role is client.
    For TLS, the choice is implicit from the usage of ``listen()``, ``accept()`` and ``connect()``.
@@ -237,8 +237,8 @@ NRF_SO_SEC_SESSION_CACHE
    This option controls TLS session caching.
    The following values are accepted:
 
-   * ``NRF_SO_SEC_SESSION_CACHE_DISABLED`` - Disable TLS session caching
-   * ``NRF_SO_SEC_SESSION_CACHE_ENABLED`` - Enable TLS session caching
+   * :c:macro:`NRF_SO_SEC_SESSION_CACHE_DISABLED` - Disable TLS session caching
+   * :c:macro:`NRF_SO_SEC_SESSION_CACHE_ENABLED` - Enable TLS session caching
 
    By default, TLS session caching is disabled.
 
@@ -252,13 +252,13 @@ NRF_SO_SEC_DTLS_HANDSHAKE_TIMEO
    The following values are accepted:
 
    * 0 -  No timeout
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_1S`` - 1 second
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_3S`` - 3 seconds
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_7S`` - 7 seconds
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_15S`` - 15 seconds
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_31S`` - 31 seconds
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_63S`` - 63 seconds
-   * ``NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_123S`` - 123 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_1S` - 1 second
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_3S` - 3 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_7S` - 7 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_15S` - 15 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_31S` - 31 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_63S` - 63 seconds
+   * :c:macro:`NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_123S` - 123 seconds
 
    The default is no timeout.
 
@@ -268,8 +268,8 @@ NRF_SO_SEC_HANDSHAKE_STATUS
    The socket option is supported from modem firmware v2.x.x.
    The following values are expected:
 
-   * ``NRF_SO_SEC_HANDSHAKE_STATUS_FULL`` - TLS/DTLS attach/negotiation procedure was made with a full handshake, and session cache data was not used or it was not accepted by the server.
-   * ``NRF_SO_SEC_HANDSHAKE_STATUS_CACHED`` - The latest TLS/DTLS attach negotiation was completed successfully with cached session data.
+   * :c:macro:`NRF_SO_SEC_HANDSHAKE_STATUS_FULL` - TLS/DTLS attach/negotiation procedure was made with a full handshake, and session cache data was not used or it was not accepted by the server.
+   * :c:macro:`NRF_SO_SEC_HANDSHAKE_STATUS_CACHED` - The latest TLS/DTLS attach negotiation was completed successfully with cached session data.
 
    The default is a full handshake.
 
@@ -278,9 +278,9 @@ NRF_SO_SEC_DTLS_CID
    The socket option is supported from modem firmware v1.3.x, where x is greater than or equal to 5, and v2.x.x.
    The following values are accepted:
 
-   * ``NRF_SO_SEC_DTLS_CID_DISABLED`` - The DTLS connection ID is not used, and the connection ID extension is not included in the client hello.
-   * ``NRF_SO_SEC_DTLS_CID_SUPPORTED`` - The DTLS connection ID is supported but not used, and the connection ID extension with a zero-length CID is included in the client hello.
-   * ``NRF_SO_SEC_DTLS_CID_ENABLED`` - The DTLS connection ID is used, and the connection ID extension with a valid CID is included in the client hello.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_DISABLED` - The DTLS connection ID is not used, and the connection ID extension is not included in the client hello.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_SUPPORTED` - The DTLS connection ID is supported but not used, and the connection ID extension with a zero-length CID is included in the client hello.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_ENABLED` - The DTLS connection ID is used, and the connection ID extension with a valid CID is included in the client hello.
 
    The default is disabled.
 
@@ -290,29 +290,29 @@ NRF_SO_SEC_DTLS_CID_STATUS
    The socket option is supported from modem firmware v1.3.x, where x is greater than or equal to 5, and v2.x.x.
    The following values are expected:
 
-   * ``NRF_SO_SEC_DTLS_CID_STATUS_DISABLED`` - The DTLS connection ID is not included in DTLS records sent to and from the modem.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_STATUS_DISABLED` - The DTLS connection ID is not included in DTLS records sent to and from the modem.
      This status is returned before the DTLS handshake is complete.
-   * ``NRF_SO_SEC_DTLS_CID_STATUS_DOWNLINK`` - The DTLS connection ID is included only in DTLS records sent to the modem.
-   * ``NRF_SO_SEC_DTLS_CID_STATUS_UPLINK`` - The DTLS connection ID is included only in DTLS records sent from the modem.
-   * ``NRF_SO_SEC_DTLS_CID_STATUS_BIDIRECTIONAL`` - The DTLS connection ID is included in DTLS records sent to and from the modem.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_STATUS_DOWNLINK` - The DTLS connection ID is included only in DTLS records sent to the modem.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_STATUS_UPLINK` - The DTLS connection ID is included only in DTLS records sent from the modem.
+   * :c:macro:`NRF_SO_SEC_DTLS_CID_STATUS_BIDIRECTIONAL` - The DTLS connection ID is included in DTLS records sent to and from the modem.
 
 NRF_SO_SEC_DTLS_CONN_SAVE
    Save DTLS connection.
    This option is write-only.
    This option require a DTLS v1.2 connection with renegotiation disabled.
    The socket option is supported from modem firmware v1.3.x, where x is greater than or equal to 5, and v2.x.x.
 
-   Once the DTLS context is saved, the socket can't be used before the DTLS context is loaded with NRF_SO_SEC_DTLS_CONN_LOAD.
+   Once the DTLS context is saved, the socket can't be used before the DTLS context is loaded with :c:macro:`NRF_SO_SEC_DTLS_CONN_LOAD`.
 
    This option will fail with nrf_errno ``NRF_EAGAIN`` if an error happened during serialization of the SSL context.
    This can occur, for instance, when the modem cannot allocate enough memory or if the socket is busy sending or receiving data.
    In this case, the SSL context is still present in the socket, so data sending is still possible.
    The option will fail with nrf_errno ``NRF_EINVAL`` if the socket option is not supported with the current configuration, for instance because the DTLS handshake is not completed,
-   the connection is not an DTLS v1.2 connection with renegotiation disabled, or the connection does not use an AEAD ciper suite (AES-CCM or AES-GCM).
+   the connection is not an DTLS v1.2 connection with renegotiation disabled, or the connection does not use an AEAD cipher suite (AES-CCM or AES-GCM).
    The option will fail with nrf_errno ``NRF_ENOMEM`` if the amount of saved connections exceeds four.
 
 NRF_SO_SEC_DTLS_CONN_LOAD
-   LOAD DTLS connection.
+   Load DTLS connection.
    This option is write-only.
    The socket option is supported from modem firmware v1.3.x, where x is greater than or equal to 5, and v2.x.x.
 
@@ -336,7 +336,7 @@ For more information about how to configure PDP contexts, activate PDN connectio
 Configuring a socket to use a PDN
 =================================
 
-The application can select which PDN to use on a specific socket by using the :c:func:`nrf_setsockopt` function, with the ``NRF_SO_BINDTODEVICE`` option and specifying the PDN ID as a string, prefixed by ``pdn``.
+The application can select which PDN to use on a specific socket by using the :c:func:`nrf_setsockopt` function, with the :c:macro:`NRF_SO_BINDTODEVICE` option and specifying the PDN ID as a string, prefixed by ``pdn``.
 For example, to select the PDN with ID 1, the application must pass ``pdn1`` as the option value.
 
 The following code shows how to create an IPv4 TCP stream socket and configure it to use the PDN with ID 1:
@@ -369,7 +369,7 @@ Handling PDN errors on sockets
 During operation, an active PDN connection may be deactivated due to loss of connectivity or other reasons.
 When a socket operation is attempted on a socket that no longer has an active PDN connection, the operation will return ``-1`` and set ``errno`` to ``NRF_ENETDOWN``.
 If the socket is being polled, the :c:func:`nrf_poll` function will set the ``POLLERR`` flag and set the socket error to ``NRF_ENETDOWN``.
-The socket error can be retrieved using the ``NRF_SO_ERROR`` socket option.
+The socket error can be retrieved using the :c:macro:`NRF_SO_ERROR` socket option.
 
 When the ``NRF_ENETDOWN`` error is detected, the socket is no longer usable and must be closed by the application.
 The application is responsible for detecting when the PDN connection is activated again, before re-creating the socket and attempting the failed operation again.
diff --git a/softdevice_controller/CHANGELOG.rst b/softdevice_controller/CHANGELOG.rst
@@ -30,8 +30,8 @@ Changes
 
 * The ``VersNr`` field in the ``LL_VERSION_IND`` packet now contains the value 0x0D to indicate compatibility with Bluetooth Core Specification v5.4 (DRGN-18624).
 * Receiving a Periodic Advertisement Sync Transfer (PAST) with invalid parameters will now generate the ``LE Periodic Advertising Sync Transfer Received`` event when receiving PAST is enabled (DRGN-18803).
-* Periodic advertiser is allocated from the Periodic Advertising with Responses (PAwR) Advertiser sets when :c:enumerator:`SDC_CFG_TYPE_PERIODIC_ADV_RSP_COUNT` is available.
-  Otherwise, it is allocated from the Periodic Advertiser sets if :c:enumerator:`SDC_CFG_TYPE_PERIODIC_ADV_COUNT` is set (DRGN-18979).
+* Periodic advertiser is allocated from the Periodic Advertising with Responses (PAwR) Advertiser sets when :c:enum:`SDC_CFG_TYPE_PERIODIC_ADV_RSP_COUNT` is available.
+  Otherwise, it is allocated from the Periodic Advertiser sets if :c:enum:`SDC_CFG_TYPE_PERIODIC_ADV_COUNT` is set (DRGN-18979).
 * The controller now returns the error code ``0x0D`` instead of ``0x09`` if it has insufficient resources to handle more connections and the host tries to start a connectable advertiser or the controller receives the commands ``LE Extended Create Connection`` or ``LE Create Connection`` (DRGN-18944).
 
 Bug fixes
