Skip to content

Commit d389a5d

Browse files
MarekPietarlubos
authored andcommitted
applications: nrf_desktop: Update HF clock lock documentation
Change updates HF clock lock module documentation. Change adds information about lack of nRF54H SoC Series support, LLPM dependency and module deprecation. Jira: NCSDK-29545 Signed-off-by: Marek Pieta <[email protected]> (cherry picked from commit a26414f)
1 parent bb97901 commit d389a5d

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

applications/nrf_desktop/doc/hfclk_lock.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ High frequency clock lock hotfix module
99

1010
Use the high frequency clock lock hotfix module to keep the high frequency clock enabled.
1111
This reduces the latency before the first packet in a row is transmitted over Bluetooth®, but it also increases the power consumption.
12-
If this module is disabled, a startup delay of around 1.5 ms will be added to the overall latency of the first packet.
12+
If this module is disabled, a startup delay of around 1.4 ms (0.85 ms in case of nRF54L Series SoCs) will be added to the overall latency of the first packet.
13+
14+
.. note::
15+
The module is deprecated.
16+
Use the :ref:`CONFIG_DESKTOP_BLE_LOW_LATENCY_LOCK <config_desktop_app_options>`) Kconfig option instead.
17+
Setting the peripheral latency Bluetooth LE connection parameter to ``0`` for a connection that uses Low Latency Packet Mode connection interval on peripheral leads to keeping the high frequency clock enabled.
18+
That mitigates the extra HID report latency caused by the high frequency clock startup delay.
1319

1420
Module events
1521
*************
@@ -24,10 +30,15 @@ Module events
2430
Configuration
2531
*************
2632

33+
The module is not supported for nRF54H SoC Series (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`).
34+
35+
Make sure that Bluetooth LE Low Latency Packet Mode (LLPM) is enabled in configuration (:kconfig:option:`CONFIG_CAF_BLE_USE_LLPM`).
36+
Using LLPM connection parameters reduces HID data latency far more significantly than enabling the module.
37+
2738
Enable the module with the :ref:`CONFIG_DESKTOP_HFCLK_LOCK_ENABLE <config_desktop_app_options>` Kconfig option.
2839

2940
Implementation details
3041
**********************
3142

32-
The high frequency clock is disabled on ``power_down_event`` and reenabled on ``wake_up_event``.
43+
The high frequency clock is disabled on :c:struct:`power_down_event` and reenabled on :c:struct:`wake_up_event`.
3344
This is done to reduce the power consumption.

0 commit comments

Comments
 (0)