Skip to content

Commit 19bf96d

Browse files
umapraseedaanangl
authored andcommitted
doc: Doc check and fixes for 2.7
Doc check and fixes for 2.7 Signed-off-by: Uma Praseeda <[email protected]>
1 parent 63a9b12 commit 19bf96d

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

nrf_modem/include/nrf_modem_dect_phy.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,7 +1131,7 @@ int nrf_modem_dect_phy_deinit(void);
11311131
* Incoming data received on the physical layer control and data channels is sent to the
11321132
* @ref nrf_modem_dect_phy_callbacks.pcc and @ref nrf_modem_dect_phy_callbacks.pdc callbacks.
11331133
*
1134-
* When the operation has completed, either successfully or unsuccesfully, the result is sent
1134+
* When the operation has completed, either successfully or unsuccessfully, the result is sent
11351135
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
11361136
* parameter equal to the `handle` specified in @p params.
11371137
*
@@ -1149,7 +1149,7 @@ int nrf_modem_dect_phy_rx(const struct nrf_modem_dect_phy_rx_params *params);
11491149
*
11501150
* Schedule a data transmission with given parameters.
11511151
*
1152-
* When the operation has completed, either successfully or unsuccesfully, the result is sent
1152+
* When the operation has completed, either successfully or unsuccessfully, the result is sent
11531153
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
11541154
* parameter equal to the `handle` specified in @p params.
11551155
*
@@ -1177,7 +1177,7 @@ int nrf_modem_dect_phy_tx(const struct nrf_modem_dect_phy_tx_params *params);
11771177
* received. In that case modem will inject ACK or NACK feedback into the Transmission feedback
11781178
* field based on the PDC reception result once the reception is complete.
11791179
*
1180-
* When the operation has completed, either successfully or unsuccesfully, the result is sent
1180+
* When the operation has completed, either successfully or unsuccessfully, the result is sent
11811181
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
11821182
* parameter equal to the `handle` specified in @p params.
11831183
*
@@ -1200,11 +1200,11 @@ int nrf_modem_dect_phy_tx_harq(const struct nrf_modem_dect_phy_tx_params *params
12001200
* The RX operation scheduling is relative to the end of the TX operation and must include
12011201
* the guard time.
12021202
*
1203-
* When the TX operation has completed, either successfully or unsuccesfully, the result is sent
1203+
* When the TX operation has completed, either successfully or unsuccessfully, the result is sent
12041204
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
12051205
* parameter equal to the `handle` specified in @p params.tx.
12061206
*
1207-
* When the RX operation has completed, either successfully or unsuccesfully, the result is sent
1207+
* When the RX operation has completed, either successfully or unsuccessfully, the result is sent
12081208
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
12091209
* parameter equal to the `handle` specified in @p params.rx.
12101210
*
@@ -1223,7 +1223,7 @@ int nrf_modem_dect_phy_tx_rx(const struct nrf_modem_dect_phy_tx_rx_params *param
12231223
* Schedule an RSSI measurement operation with given parameters.
12241224
* The measurements are sent to the @ref nrf_modem_dect_phy_callbacks.rssi callback.
12251225
*
1226-
* When the operation has completed, either successfully or unsuccesfully, the result is sent
1226+
* When the operation has completed, either successfully or unsuccessfully, the result is sent
12271227
* to the @ref nrf_modem_dect_phy_callbacks.op_complete callback, with a `handle`
12281228
* parameter equal to the `handle` specified in @p params.
12291229
*

nrf_rpc/doc/protocol_specification.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A description of the various fields and their meaning:
5858
The remote processor is then obliged to use the source context ID as the destination context ID in the response packet.
5959
This ensures that responses and any packets that follow within each conversation are correctly routed to the initiating thread.
6060

61-
The exact source context ID allocation pattern is implementation-defined, meaning that when the packet sender intiates a new conversation or responds to the initiating packet, it is free to allocate any unused source context ID for the new conversation.
61+
The exact source context ID allocation pattern is implementation-defined, meaning that when the packet sender initiates a new conversation or responds to the initiating packet, it is free to allocate any unused source context ID for the new conversation.
6262

6363
``Command ID``: 8 bits
6464
Identifies an individual command or event within an nRF RPC group.

softdevice_controller/CHANGELOG.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Changes
3535
Generally, this change will result in either increased scanning time, or similar scanning time to before.
3636
In cases where there are many conflicting activities within the scan window, this change may result in reduced scanning time. (DRGN-19050)
3737
* Scan windows are no longer limited to 16 seconds. (DRGN-19050)
38-
* The deprecated functions :c:func:`rand_prio_low_get` and :c:func:`rand_prio_high_get` have been removed.
38+
* The deprecated structure members ``sdc_rand_source_t.rand_prio_low_get`` and ``sdc_rand_source_t.rand_prio_high_get`` have been removed.
3939
This change does not affect applications developed in the |NCS| context. (DRGN-20473)
4040
* The HCI commands used to configure a scanner or initiator no longer return ``BT_HCI_ERR_INVALID_PARAM`` when the sum of scan windows is greater than the scan interval.
4141
Now the controller will truncate the scan windows so that the sum of the windows fit within the scan interval. (DRGN-21710)
@@ -57,13 +57,13 @@ Changes
5757
Bug fixes
5858
=========
5959

60-
* Fixed an issue where an assert could happen if a initiator ran for more than 2147 seconds before connecting (DRGN-22163).
60+
* Fixed an issue where an assert could happen if an initiator ran for more than 2147 seconds before connecting (DRGN-22163).
6161
* Fixed an extremely rare race condition where using :c:func:`sdc_soc_ecb_block_encrypt` from an ISR could lead to encryption failures. (DRGN-21603)
6262
* Fixed an issue where the vendor-specific ISO Read TX Timestamp command returned a timestamp that was 41 µs too small (DRGN-21605).
6363
* Fixed an issue where an assert could happen if a CIS peripheral stopped receiving packets from the CIS central.
6464
This would only occur after the window widening reached at least half of the ISO interval in magnitude.
6565
Assuming worst case clock accuracies on both central and peripheral, this would correspond to 2.4, 3.7, and 4.9 seconds for ISO intervals of 5 ms, 7.5 ms, and 10 ms.
66-
This issue would not occur if the supervision timeout was set to a value smaller than the onces mentioned above (DRGN-21619).
66+
This issue would not occur if the supervision timeout was set to a value smaller than the ones mentioned above (DRGN-21619).
6767
* Fixed an issue where the peripheral waited for a link to time out when tearing down the connection.
6868
This happened when the central would acknowledge ``TERMINATE_IND`` in the same event as it was being sent (DRGN-21637).
6969
* Fixed an issue where the |controller| would accept the HCI LE Set Random Address command while passive scanning had been enabled.

softdevice_controller/doc/isochronous_channels.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Configurations for parallel use of CIS and BIS
6161

6262
Parallel use of one CIS and one BIS is tested.
6363
However, there is no absolute maximum of BISes, CISes and ACLs that can be used concurrently.
64-
Instead, the amount of roles that can be used at the same time is limited by available memory and the on-air timings.
64+
Instead, the number of roles that can be used at the same time is limited by available memory and the on-air timings.
6565

6666
Tested topologies
6767
*****************
@@ -194,7 +194,7 @@ Time of arrival
194194
Expect a larger latency if data is not provided every SDU interval and the stream is configured with retransmissions.
195195
This is due to the fact that the controller first needs to send empty data packets for the data that was not provided.
196196
In case data is missing, the controller sends NULL data every ISO event.
197-
This also ensures that the data provided with the time of arrival mode is retransmitted the configured amount of times.
197+
This also ensures that the data provided with the time of arrival mode is retransmitted the configured number of times.
198198

199199
Use this mode if the exact time when an SDU is sent does not matter or if SDUs are only produced at a rate much smaller than the SDU interval.
200200
To use this mode, set the sequence number to 0 and do not add a timestamp to the HCI ISO data.
@@ -208,7 +208,7 @@ Sequence numbers
208208
The controller learns the initial sequence number, so there is no need to align the sequence number each time with the one that is returned when calling the HCI VS ISO Read TX Timestamp command.
209209

210210
Pay special attention on the CIS peripheral side, because the timings of ISO are based on the central's clock.
211-
This means that you need to account for drift between the central's and the peripheral's clocks for the the generation of SDUs.
211+
This means that you need to account for drift between the central's and the peripheral's clocks for the generation of SDUs.
212212
To do this, use the HCI VS ISO Read TX Timestamp command.
213213
The command provides a timestamp corresponding to the last possible point in time that the previous SDU could have been provided.
214214
When combined with the SDU interval, this gives an indication of the last possible time when an SDU can be provided.
@@ -230,7 +230,7 @@ The application needs to inform the |controller| which SDUs should be time-synch
230230

231231
The recommended way to provide this information is using the timestamps mode.
232232
Using the same timestamp for multiple SDUs guarantees that the SDUs are time-synchronized.
233-
Synchronization can not be reliably achieved using the time of arrival method.
233+
Synchronization cannot be reliably achieved using the time of arrival method.
234234
See the :ref:`iso_providing_data` section for more information.
235235

236236
The following logical flow demonstrates how to send time-synchronized SDUs on multiple CISes or BISes:

softdevice_controller/include/sdc_hci_vs.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,8 +1677,8 @@ uint8_t sdc_hci_cmd_vs_scan_accept_ext_adv_packets_set(const sdc_hci_cmd_vs_scan
16771677
* This means that there is no guarantee that the controller works as intended when non-tested
16781678
* priorities are used.
16791679
* The default values for the priorities of the different roles are listed in
1680-
* https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrfxlib/softdevice_controller/doc/sch
1681-
* eduling.html
1680+
* https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/softdevice_controller/doc/scheduling.html
1681+
*
16821682
*
16831683
* Priority changes configured using this API are not persisted on resets.
16841684
*

0 commit comments

Comments
 (0)