reset.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Andrei-Edward Popa <[email protected]>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_RESET_H_
#define ZEPHYR_INCLUDE_DRIVERS_RESET_H_
 
#include <errno.h>
 
#include <zephyr/types.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct reset_dt_spec {
        const struct device *dev;
        uint32_t id;
};
 
#define RESET_DT_SPEC_GET_BY_IDX(node_id, idx)                                  \
        {                                                                       \
                .dev = DEVICE_DT_GET(DT_RESET_CTLR_BY_IDX(node_id, idx)),       \
                .id = DT_RESET_ID_BY_IDX(node_id, idx)                          \
        }
 
#define RESET_DT_SPEC_GET_BY_IDX_OR(node_id, idx, default_value)        \
        COND_CODE_1(DT_NODE_HAS_PROP(node_id, resets),                  \
                    (RESET_DT_SPEC_GET_BY_IDX(node_id, idx)),           \
                    (default_value))
 
#define RESET_DT_SPEC_GET(node_id) \
        RESET_DT_SPEC_GET_BY_IDX(node_id, 0)
 
#define RESET_DT_SPEC_GET_OR(node_id, default_value)                    \
        RESET_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value)
 
#define RESET_DT_SPEC_INST_GET_BY_IDX(inst, idx) \
        RESET_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx)
 
#define RESET_DT_SPEC_INST_GET_BY_IDX_OR(inst, idx, default_value)      \
        COND_CODE_1(DT_PROP_HAS_IDX(DT_DRV_INST(inst), resets, idx),    \
                    (RESET_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx)), \
                    (default_value))
 
#define RESET_DT_SPEC_INST_GET(inst) \
        RESET_DT_SPEC_INST_GET_BY_IDX(inst, 0)
 
#define RESET_DT_SPEC_INST_GET_OR(inst, default_value)                  \
        RESET_DT_SPEC_INST_GET_BY_IDX_OR(inst, 0, default_value)
 
typedef int (*reset_api_status)(const struct device *dev, uint32_t id, uint8_t *status);
 
typedef int (*reset_api_line_assert)(const struct device *dev, uint32_t id);
 
typedef int (*reset_api_line_deassert)(const struct device *dev, uint32_t id);
 
typedef int (*reset_api_line_toggle)(const struct device *dev, uint32_t id);
 
__subsystem struct reset_driver_api {
        reset_api_status status;
        reset_api_line_assert line_assert;
        reset_api_line_deassert line_deassert;
        reset_api_line_toggle line_toggle;
};
 
__syscall int reset_status(const struct device *dev, uint32_t id, uint8_t *status);
 
static inline int z_impl_reset_status(const struct device *dev, uint32_t id, uint8_t *status)
{
        const struct reset_driver_api *api = (const struct reset_driver_api *)dev->api;
 
        if (api->status == NULL) {
                return -ENOSYS;
        }
 
        return api->status(dev, id, status);
}
 
static inline int reset_status_dt(const struct reset_dt_spec *spec, uint8_t *status)
{
        return reset_status(spec->dev, spec->id, status);
}
 
__syscall int reset_line_assert(const struct device *dev, uint32_t id);
 
static inline int z_impl_reset_line_assert(const struct device *dev, uint32_t id)
{
        const struct reset_driver_api *api = (const struct reset_driver_api *)dev->api;
 
        if (api->line_assert == NULL) {
                return -ENOSYS;
        }
 
        return api->line_assert(dev, id);
}
 
static inline int reset_line_assert_dt(const struct reset_dt_spec *spec)
{
        return reset_line_assert(spec->dev, spec->id);
}
 
__syscall int reset_line_deassert(const struct device *dev, uint32_t id);
 
static inline int z_impl_reset_line_deassert(const struct device *dev, uint32_t id)
{
        const struct reset_driver_api *api = (const struct reset_driver_api *)dev->api;
 
        if (api->line_deassert == NULL) {
                return -ENOSYS;
        }
 
        return api->line_deassert(dev, id);
}
 
static inline int reset_line_deassert_dt(const struct reset_dt_spec *spec)
{
        return reset_line_deassert(spec->dev, spec->id);
}
 
__syscall int reset_line_toggle(const struct device *dev, uint32_t id);
 
static inline int z_impl_reset_line_toggle(const struct device *dev, uint32_t id)
{
        const struct reset_driver_api *api = (const struct reset_driver_api *)dev->api;
 
        if (api->line_toggle == NULL) {
                return -ENOSYS;
        }
 
        return api->line_toggle(dev, id);
}
 
static inline int reset_line_toggle_dt(const struct reset_dt_spec *spec)
{
        return reset_line_toggle(spec->dev, spec->id);
}
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/reset.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_RESET_H_ */