Skip to content

Commit fc61155

Browse files
committed
caf: power_manager: Document Kconfig changes
Change adds documentation for introduced Kconfig configuration changes. Jira: NCSDK-32519 Signed-off-by: Marek Pieta <Marek.Pieta@nordicsemi.no> Signed-off-by: Divya Pillai <divya.pillai@nordicsemi.no>
1 parent 1b0df5c commit fc61155

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

doc/nrf/libraries/caf/power_manager.rst

+23-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,29 @@ Configuration
1515

1616
To enable the |power_manager|, set the :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option in the configuration.
1717

18-
This module uses Zephyr's :ref:`zephyr:pm_api` subsystem.
18+
Implied features
19+
================
20+
21+
The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` option implies the following features that can be used to reduce power consumption:
22+
23+
* System power off support (:kconfig:option:`CONFIG_POWEROFF`).
24+
The option is not implied for an nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`), because the :c:func:`sys_poweroff` API is not yet fully supported on the nRF54H Series SoC.
25+
* Device Power Management (:kconfig:option:`CONFIG_PM_DEVICE`).
26+
The option allows to reduce power consumption of device drivers while they are inactive.
27+
You can disable the feature if your application does not use device drivers that integrate device power management.
28+
Disabling the feature reduces memory footprint.
29+
30+
nRF54H Series SoC
31+
-----------------
32+
33+
For the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`), the module also implies the following features:
34+
35+
* Zephyr's :ref:`zephyr:pm-system` (:kconfig:option:`CONFIG_PM`).
36+
The nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`) integrates the system power management to reduce power consumption when inactive.
37+
* Zephyr's :ref:`zephyr:pm-device-runtime` (:kconfig:option:`CONFIG_PM_DEVICE_RUNTIME`).
38+
The option extends device power management and depends on :kconfig:option:`CONFIG_PM_DEVICE` Kconfig option.
39+
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
40+
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.
1941

2042
Timeout configuration options
2143
=============================

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

+11
Original file line numberDiff line numberDiff line change
@@ -808,6 +808,17 @@ Common Application Framework
808808
Earlier, only **GPIO0** and **GPIO1** devices were supported.
809809
Now, the generic solution supports all GPIOs available in the DTS.
810810

811+
* :ref:`caf_power_manager`:
812+
813+
* Updated:
814+
815+
* The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option to imply the device power management (:kconfig:option:`CONFIG_DEVICE_PM`) instead of selecting it.
816+
The device power management is not required by the module.
817+
* The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option to imply device runtime power management (:kconfig:option:`CONFIG_PM_DEVICE_RUNTIME`) for the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`).
818+
The feature can be used to reduce the power consumption of device drivers.
819+
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
820+
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.
821+
811822
Debug libraries
812823
---------------
813824

0 commit comments

Comments
 (0)