wuc.h

Go to the documentation of this file.

/*
 * Copyright 2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_WUC_H_
#define ZEPHYR_INCLUDE_DRIVERS_WUC_H_

 
#include <errno.h>
#include <stddef.h>
 
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct wuc_dt_spec {
        const struct device *dev;
        uint32_t id;
};

#define WUC_DT_SPEC_GET_BY_IDX(node_id, idx)                                                       \
        {.dev = DEVICE_DT_GET(DT_WUC_BY_IDX(node_id, idx)), .id = DT_WUC_ID_BY_IDX(node_id, idx)}

#define WUC_DT_SPEC_GET_BY_IDX_OR(node_id, idx, default_value)                                     \
        COND_CODE_1(DT_NODE_HAS_PROP(node_id, wakeup_ctrls),                    \
                    (WUC_DT_SPEC_GET_BY_IDX(node_id, idx)),             \
                    (default_value))

#define WUC_DT_SPEC_GET(node_id) WUC_DT_SPEC_GET_BY_IDX(node_id, 0)

#define WUC_DT_SPEC_GET_OR(node_id, default_value)                                                 \
        WUC_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value)

#define WUC_DT_SPEC_INST_GET_BY_IDX(inst, idx) WUC_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx)

#define WUC_DT_SPEC_INST_GET_BY_IDX_OR(inst, idx, default_value)                                   \
        COND_CODE_1(DT_PROP_HAS_IDX(DT_DRV_INST(inst), wakeup_ctrls, idx), \
                (WUC_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx)),       \
                (default_value))

#define WUC_DT_SPEC_INST_GET(inst) WUC_DT_SPEC_INST_GET_BY_IDX(inst, 0)

#define WUC_DT_SPEC_INST_GET_OR(inst, default_value)                                               \
        WUC_DT_SPEC_INST_GET_BY_IDX_OR(inst, 0, default_value)

typedef int (*wuc_api_enable_wakeup_source)(const struct device *dev, uint32_t id);
 
typedef int (*wuc_api_disable_wakeup_source)(const struct device *dev, uint32_t id);
 
typedef int (*wuc_api_check_wakeup_source_triggered)(const struct device *dev, uint32_t id);
 
typedef int (*wuc_api_clear_wakeup_source_triggered)(const struct device *dev, uint32_t id);
 
__subsystem struct wuc_driver_api {
        wuc_api_enable_wakeup_source enable;
        wuc_api_disable_wakeup_source disable;
        wuc_api_check_wakeup_source_triggered triggered;
        wuc_api_clear_wakeup_source_triggered clear;
};

static inline int wuc_enable_wakeup_source(const struct device *dev, uint32_t id)
{
        return DEVICE_API_GET(wuc, dev)->enable(dev, id);
}

static inline int wuc_enable_wakeup_source_dt(const struct wuc_dt_spec *spec)
{
        return wuc_enable_wakeup_source(spec->dev, spec->id);
}

static inline int wuc_disable_wakeup_source(const struct device *dev, uint32_t id)
{
        return DEVICE_API_GET(wuc, dev)->disable(dev, id);
}

static inline int wuc_disable_wakeup_source_dt(const struct wuc_dt_spec *spec)
{
        return wuc_disable_wakeup_source(spec->dev, spec->id);
}

static inline int wuc_check_wakeup_source_triggered(const struct device *dev, uint32_t id)
{
        if (DEVICE_API_GET(wuc, dev)->triggered == NULL) {
                return -ENOSYS;
        }
        return DEVICE_API_GET(wuc, dev)->triggered(dev, id);
}

static inline int wuc_check_wakeup_source_triggered_dt(const struct wuc_dt_spec *spec)
{
        return wuc_check_wakeup_source_triggered(spec->dev, spec->id);
}

static inline int wuc_clear_wakeup_source_triggered(const struct device *dev, uint32_t id)
{
        if (DEVICE_API_GET(wuc, dev)->clear == NULL) {
                return -ENOSYS;
        }
        return DEVICE_API_GET(wuc, dev)->clear(dev, id);
}

static inline int wuc_clear_wakeup_source_triggered_dt(const struct wuc_dt_spec *spec)
{
        return wuc_clear_wakeup_source_triggered(spec->dev, spec->id);
}
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_DRIVERS_WUC_H_ */