wuc.h File Reference

Main header file for WUC (Wakeup Controller) driver API. More...

#include <errno.h>
#include <stddef.h>
#include <zephyr/device.h>

Go to the source code of this file.

Data Structures
struct	wuc_dt_spec
	Wakeup controller device configuration. More...

Macros
#define	WUC_DT_SPEC_GET_BY_IDX(node_id, idx)
	Static initializer for a wuc_dt_spec.
#define	WUC_DT_SPEC_GET_BY_IDX_OR(node_id, idx, default_value)
	Like WUC_DT_SPEC_GET_BY_IDX(), with a fallback to a default value.
#define	WUC_DT_SPEC_GET(node_id)
	Equivalent to WUC_DT_SPEC_GET_BY_IDX(node_id, 0).
#define	WUC_DT_SPEC_GET_OR(node_id, default_value)
	Equivalent to WUC_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value).
#define	WUC_DT_SPEC_INST_GET_BY_IDX(inst, idx)
	Static initializer for a wuc_dt_spec from a DT_DRV_COMPAT instance's Wakeup Controller property at an index.
#define	WUC_DT_SPEC_INST_GET_BY_IDX_OR(inst, idx, default_value)
	Static initializer for a wuc_dt_spec from a DT_DRV_COMPAT instance's 'wakeup-ctrls' property at an index, with fallback.
#define	WUC_DT_SPEC_INST_GET(inst)
	Equivalent to WUC_DT_SPEC_INST_GET_BY_IDX(inst, 0).
#define	WUC_DT_SPEC_INST_GET_OR(inst, default_value)
	Equivalent to WUC_DT_SPEC_INST_GET_BY_IDX_OR(node_id, 0, default_value).

Functions
static int	wuc_enable_wakeup_source (const struct device *dev, uint32_t id)
	Enable a wakeup source.
static int	wuc_enable_wakeup_source_dt (const struct wuc_dt_spec *spec)
	Enable a wakeup source using a wuc_dt_spec.
static int	wuc_disable_wakeup_source (const struct device *dev, uint32_t id)
	Disable a wakeup source.
static int	wuc_disable_wakeup_source_dt (const struct wuc_dt_spec *spec)
	Disable a wakeup source using a wuc_dt_spec.
static int	wuc_check_wakeup_source_triggered (const struct device *dev, uint32_t id)
	Check if a wakeup source triggered.
static int	wuc_check_wakeup_source_triggered_dt (const struct wuc_dt_spec *spec)
	Check if a wakeup source triggered using a wuc_dt_spec.
static int	wuc_clear_wakeup_source_triggered (const struct device *dev, uint32_t id)
	Clear a wakeup source triggered status.
static int	wuc_clear_wakeup_source_triggered_dt (const struct wuc_dt_spec *spec)
	Clear a wakeup source triggered status using a wuc_dt_spec.

Detailed Description

Main header file for WUC (Wakeup Controller) driver API.