Skip to content

Commit 4b73c63

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 8798f86 commit 4b73c63

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

doc/nrf/libraries/caf/power_manager.rst

+20-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,26 @@ 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+
27+
nRF54H Series SoC
28+
-----------------
29+
30+
For the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`), the module also implies the following features:
31+
32+
* Zephyr's :ref:`zephyr:pm-system` (:kconfig:option:`CONFIG_PM`).
33+
The nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`) integrates the system power management to reduce power consumption when inactive.
34+
* Zephyr's :ref:`zephyr:pm-device-runtime` (:kconfig:option:`CONFIG_PM_DEVICE_RUNTIME`).
35+
The feature can be used to reduce power consumption of device drivers.
36+
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
37+
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.
1938

2039
Timeout configuration options
2140
=============================

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

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

793+
* :ref:`caf_power_manager`:
794+
795+
* Updated:
796+
797+
* The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option to imply the device power management (:kconfig:option:`CONFIG_DEVICE_PM`) instead of selecting it.
798+
The device power management is not required by the module.
799+
* 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`).
800+
The feature can be used to reduce the power consumption of device drivers.
801+
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
802+
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.
803+
793804
Debug libraries
794805
---------------
795806

0 commit comments

Comments
 (0)