Skip to content

Commit

Permalink
doc: update missing toc
Browse files Browse the repository at this point in the history
Update missing toc

Signed-off-by: divya pillai <[email protected]>
  • Loading branch information
divipillai committed Mar 4, 2024
1 parent 319739c commit 71b15fc
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 19 deletions.
4 changes: 2 additions & 2 deletions nrf_802154/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _nrf_802154:

nRF 802.15.4 Radio Driver
=========================
#########################

The nRF 802.15.4 Radio Driver is a set of libraries that implement the IEEE 802.15.4 functionalities for the SoCs from the nRF52 and nRF53 families.
The nRF 802.15.4 Radio Driver is a set of libraries that implement the IEEE 802.15.4 functionalities for the SoCs from the nRF52 and nRF53 Series.
The following functionalities are implemented:

* Frame transmission.
Expand Down
4 changes: 4 additions & 0 deletions nrf_802154/doc/rd_including.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Including the nRF 802.15.4 Radio Driver in a project
####################################################

.. contents::
:local:
:depth: 2

You can include the nRF 802.15.4 Radio Driver in your project using either CMake or other build systems.

.. _nrf_802154_build_cmake:
Expand Down
4 changes: 4 additions & 0 deletions nrf_modem/doc/modem_trace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Modem traces
############

.. contents::
:local:
:depth: 2

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.

Expand Down
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions nrf_modem/doc/sockets/pdn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ 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 :c:macro:`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 :c:macro:`NRF_ENETDOWN`.
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 :c:macro:`NRF_SO_ERROR` socket option.

When the :c:macro:`NRF_ENETDOWN` error is detected, the socket is no longer usable and must be closed by the application.
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.
2 changes: 1 addition & 1 deletion nrf_modem/doc/sockets/rai.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Release Assistance Indication (RAI) is a feature introduced in 3GPP Release 13 a
It is designed to optimize the power consumption of IoT devices by allowing them to inform the network that they do not expect any more data to be sent or received after their current transmission.
This enables the device to transition to a low-power state more quickly.
RAI is particularly useful for devices operating on LTE-M and NB-IoT networks, where power efficiency is crucial.
By using RAI, devices can reduce the time they spend in the higher power-consuming RRC_CONNECTED state, thus saving battery life.
By using RAI, devices can reduce the time they spend in the higher power-consuming ``RRC_CONNECTED`` state, thus saving battery life.

.. note::
The decision to release the connection is still at the discretion of the network provider.
Expand Down
22 changes: 11 additions & 11 deletions nrf_modem/doc/sockets/socket_options_func.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ NRF_SO_RCVTIMEO
Set a timeout value for the :c:func:`nrf_recv`, :c:func:`nrf_recvfrom` and :c:func:`nrf_accept` operations.
This option accepts an :c:struct:`nrf_timeval` structure with a number of seconds and microseconds specifying the limit on how long to wait for an input operation to complete.
If a receive operation has blocked for this much time without receiving additional data, it returns with a partial count, or ``errno`` is set to ``NRF_EAGAIN`` or ``NRF_EWOULDBLOCK`` if no data were received.
If an accept operation has blocked for this much time without receiving an incoming connection, it returns ``-1`` and ``errno`` is set to :c:macro:`NRF_EAGAIN`.
If an accept operation has blocked for this much time without receiving an incoming connection, it returns ``-1`` and ``errno`` is set to ``NRF_EAGAIN``.
The default for this option is the value ``0``, which indicates that a receive or accept operation will not time out.

.. note::
Expand Down Expand Up @@ -206,27 +206,27 @@ NRF_SO_RAI
* ``NRF_RAI_WAIT_MORE`` - Keep RRC in connected mode after the next output operation on this socket (server side).

NRF_SO_RAI_LAST
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value :c:macro:`NRF_RAI_LAST` instead.
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value ``NRF_RAI_LAST`` instead.
This is a Release assistance indication (RAI) socket option.
Enter RRC idle mode after the next output operation on this socket is complete.

NRF_SO_RAI_ONE_RESP
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value :c:macro:`NRF_RAI_ONE_RESP` instead.
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value ``NRF_RAI_ONE_RESP`` instead.
This is a Release assistance indication (RAI) socket option.
After the next output operation is complete, wait for one more packet to be received from the network on this socket before entering RRC idle mode.

NRF_SO_RAI_ONGOING
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value :c:macro:`NRF_RAI_ONGOING` instead.
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value ``NRF_RAI_ONGOING`` instead.
This is a Release assistance indication (RAI) socket option.
Keep RRC in connected mode after the next output operation on this socket (client side).

NRF_SO_RAI_WAIT_MORE
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value :c:macro:`NRF_RAI_WAIT_RESP` instead.
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value ``NRF_RAI_WAIT_RESP`` instead.
This is a Release assistance indication (RAI) socket option.
Keep RRC in connected mode after the next output operation on this socket (server side).

NRF_SO_RAI_NO_DATA
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value :c:macro:`NRF_RAI_NO_DATA` instead.
Deprecated since v2.6.0. Use the :c:macro:`NRF_SO_RAI` socket option with value ``NRF_RAI_NO_DATA`` instead.
This is a Release assistance indication (RAI) socket option.
Immediately enter RRC idle mode for this socket.
Does not require a following output operation.
Expand Down Expand Up @@ -377,21 +377,21 @@ NRF_SO_SEC_DTLS_CONN_SAVE

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 fails with nrf_errno :c:macro:`NRF_EAGAIN` if an error happened during serialization of the SSL context.
This option fails 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 fails with nrf_errno :c:macro:`NRF_EINVAL` if the socket option is not supported with the current configuration, for instance because the DTLS handshake is not completed,
The option fails 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 cipher suite (AES-CCM or AES-GCM).
The option fails with nrf_errno :c:macro:`NRF_ENOMEM` if the number of saved connections exceeds four.
The option fails with nrf_errno ``NRF_ENOMEM`` if the number of saved connections exceeds four.

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

This option fails with nrf_errno :c:macro:`NRF_EAGAIN` if an error happened during deserialization of the SSL context.
This option fails with nrf_errno ``NRF_EAGAIN`` if an error happened during deserialization of the SSL context.
This can occur, for instance, when the modem cannot allocate enough memory or the connection is not saved.
The option fails with nrf_errno :c:macro:`NRF_EINVAL` if the socket option is not supported with the current configuration.
The option fails with nrf_errno ``NRF_EINVAL`` if the socket option is not supported with the current configuration.

NRF_SO_SEC_CIPHERSUITE_USED
Get chosen TLS cipher suite.
Expand Down
4 changes: 2 additions & 2 deletions nrf_modem/doc/sockets/tls_dtls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Testing TLS traffic decryption
Before you start testing TLS traffic decryption, make sure that the following prerequisites are satisfied:

#. The device runs an application that supports TLS.
The TLS session is created using certificates stored to tags ranging between the values specified in :c:macro:`NRF_SEC_TAG_TLS_DECRYPT_0` and :c:macro:`NRF_SEC_TAG_TLS_DECRYPT_19`.
The TLS session is created using certificates stored to tags ranging between the values specified in ``NRF_SEC_TAG_TLS_DECRYPT_0`` and ``NRF_SEC_TAG_TLS_DECRYPT_19``.
#. The device has modem traces enabled.
For information on modem traces and how to enable them, see the :ref:`modem_trace` documentation.
#. Modem firmware v2.0.0 or higher is programmed on your device.
Expand All @@ -98,7 +98,7 @@ Before you start testing TLS traffic decryption, make sure that the following pr

Complete the following steps to test TLS traffic decryption:

#. |connect_kit|
#. Connect the kit to the computer using a USB cable.
#. Open the `Cellular Monitor`_ desktop application and connect the device.
#. Select :guilabel:`Autoselect` from the **Modem trace database** drop-down menu, or a modem firmware version that is programmed on the device.
#. Make sure that :guilabel:`Open in Wireshark` is selected.
Expand Down

0 comments on commit 71b15fc

Please sign in to comment.