Skip to content

Commit bb876cd

Browse files
peknisanangl
authored andcommitted
doc: IPC radio fw application: update Kconfigs
Updated the formatting of the application-specific and sysbuild Kconfig options. Signed-off-by: Pekka Niskanen <[email protected]>
1 parent 37cf8d1 commit bb876cd

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

applications/ipc_radio/README.rst

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,35 +60,53 @@ Configuration
6060

6161
|config|
6262

63-
Application
64-
===========
63+
Configuration options
64+
=====================
6565

6666
You can set the supported radio configurations using the following Kconfig options:
6767

68-
* :kconfig:option:`CONFIG_IPC_RADIO_BT` - For the Bluetooth Low Energy serialization.
69-
* :kconfig:option:`CONFIG_IPC_RADIO_802154` - For the IEEE 802.15.4 serialization.
68+
.. _CONFIG_IPC_RADIO_BT:
69+
70+
CONFIG_IPC_RADIO_BT
71+
This option enables the IPC Bluetooth Low Energy radio serialization.
72+
73+
.. _CONFIG_IPC_RADIO_802154:
74+
75+
CONFIG_IPC_RADIO_802154
76+
This option enables the IPC IEEE 802.15.4 radio serialization.
77+
78+
You can select the Bluetooth Low Energy serialization using the following Kconfig options:
79+
80+
.. _CONFIG_IPC_RADIO_BT_SER:
81+
82+
CONFIG_IPC_RADIO_BT_SER
83+
This option selects the type of the IPC Bluetooth radio serialization.
84+
85+
.. _CONFIG_IPC_RADIO_BT_HCI_IPC:
7086

87+
CONFIG_IPC_RADIO_BT_HCI_IPC
88+
This option enables the Bluetooth HCI serialization.
7189

72-
You can select the Bluetooth Low Energy serialization using the ``CONFIG_IPC_RADIO_BT_SER`` Kconfig choice:
90+
.. _CONFIG_IPC_RADIO_BT_RPC:
7391

74-
* :kconfig:option:`CONFIG_IPC_RADIO_BT_HCI_IPC` - For the Bluetooth HCI serialization.
75-
* :kconfig:option:`CONFIG_IPC_RADIO_BT_RPC` - For the Bluetooth host API serialization.
92+
CONFIG_IPC_RADIO_BT_RPC
93+
This option enables the Bluetooth host API serialization over RPC.
7694

7795
The Bluetooth Low Energy and IEEE 802.15.4 functionalities can operate simultaneously and are only limited by available memory.
7896

7997
Sysbuild Kconfig options
8098
========================
8199

82-
To enable the firmware, use the sysbuild configuration ``SB_CONFIG_NETCORE_IPC_RADIO``.
100+
To enable the firmware, use the sysbuild configuration :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO`.
83101

84102
You can set the supported radio configurations using the following sysbuild Kconfig options:
85103

86-
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC``
87-
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_RPC``
88-
* ``SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154``
104+
* :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC`
105+
* :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_BT_RPC`
106+
* :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154`
89107

90108
.. note::
91-
For |NCS| samples and applications, use the ``SB_CONFIG_NRF_DEFAULT_IPC_RADIO`` sysbuild configuration to enable the firmware instead of ``SB_CONFIG_NETCORE_IPC_RADIO`` (which should only be used for production).
109+
For |NCS| samples and applications, use the :kconfig:option:`SB_CONFIG_NRF_DEFAULT_IPC_RADIO` sysbuild configuration to enable the firmware instead of :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO` (which must only be used for production).
92110

93111
Configuration files
94112
===================
@@ -106,7 +124,7 @@ The following files are available:
106124
When you use sysbuild to build an application which uses the IPC radio firmware as the network or radio core image, the preceding configuration files are added automatically to the IPC radio firmware.
107125
The selection of specific configuration files is determined by the sysbuild Kconfig.
108126

109-
For instance, the ``SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154`` Kconfig option enables the :file:`overlay-802154.conf` configuration file to be used with the IPC radio firmware.
127+
For instance, the :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154` sysbuild Kconfig option enables the :file:`overlay-802154.conf` configuration file to be used with the IPC radio firmware.
110128

111129
.. _ipc_radio_build_run:
112130

0 commit comments

Comments
 (0)