Zephyr API Documentation 4.5.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
System Timer Low-power Companion Interface

System timer low-power companion interface. More...

Macros

#define SYSTEM_TIMER_COMPANION_NODE   DT_CHOSEN(zephyr_system_timer_companion)
 Devicetree node identifier of the system timer low-power companion.

Detailed Description

System timer low-power companion interface.

Attention
Available only when the following Kconfig options are enabled: CONFIG_SYSTEM_TIMER_LPM_COMPANION_COUNTER, CONFIG_SYSTEM_TIMER_LPM_COMPANION_HOOKS.

This interface is used when a system timer low-power companion is configured. It is not available when CONFIG_SYSTEM_TIMER_LPM_COMPANION_NONE is enabled.

If CONFIG_SYSTEM_TIMER_LPM_COMPANION_HOOKS is selected, SoC/platform-specific code provides the implementation of all hooks; otherwise, the implementation is provided by the system timer subsystem.

Macro Definition Documentation

◆ SYSTEM_TIMER_COMPANION_NODE

#define SYSTEM_TIMER_COMPANION_NODE   DT_CHOSEN(zephyr_system_timer_companion)

#include <zephyr/drivers/timer/system_timer_lpm.h>

Devicetree node identifier of the system timer low-power companion.

Selects the node referenced by the zephyr,system-timer-companion chosen property. Use DT_NODE_EXISTS() to check whether the selected node exists.