mbox.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2021 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MBOX_H_
#define ZEPHYR_INCLUDE_DRIVERS_MBOX_H_
 
#include <kernel.h>
#include <device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct mbox_msg {
        const void *data;
 
        size_t size;
};
 
struct mbox_channel {
        const struct device *dev;
 
        uint32_t id;
};
 
#define MBOX_DT_CHANNEL_GET(node_id, name)                                      \
        {                                                                       \
                .dev = DEVICE_DT_GET(MBOX_DT_CTLR_BY_NAME(node_id, name)),      \
                .id = MBOX_DT_CHANNEL_ID_BY_NAME(node_id, name),                \
        }
 
#define MBOX_DT_CTLR_BY_NAME(node_id, name) \
        DT_PHANDLE_BY_NAME(node_id, mboxes, name)
 
#define MBOX_DT_CHANNEL_ID_BY_NAME(node_id, name) \
        DT_PHA_BY_NAME_OR(node_id, mboxes, name, channel, 0)
 
typedef void (*mbox_callback_t)(const struct device *dev, uint32_t channel,
                                void *user_data, struct mbox_msg *data);
 
typedef int (*mbox_send_t)(const struct device *dev, uint32_t channel,
                           const struct mbox_msg *msg);
 
typedef int (*mbox_mtu_get_t)(const struct device *dev);
 
typedef int (*mbox_register_callback_t)(const struct device *dev,
                                        uint32_t channel,
                                        mbox_callback_t cb,
                                        void *user_data);
 
typedef int (*mbox_set_enabled_t)(const struct device *dev, uint32_t channel, bool enable);
 
typedef uint32_t (*mbox_max_channels_get_t)(const struct device *dev);
 
__subsystem struct mbox_driver_api {
        mbox_send_t send;
        mbox_register_callback_t register_callback;
        mbox_mtu_get_t mtu_get;
        mbox_max_channels_get_t max_channels_get;
        mbox_set_enabled_t set_enabled;
};
 
static inline void mbox_init_channel(struct mbox_channel *channel, const struct device *dev,
                                     uint32_t ch_id)
{
        channel->dev = dev;
        channel->id = ch_id;
}
 
__syscall int mbox_send(const struct mbox_channel *channel, const struct mbox_msg *msg);
 
static inline int z_impl_mbox_send(const struct mbox_channel *channel, const struct mbox_msg *msg)
{
        const struct mbox_driver_api *api =
                (const struct mbox_driver_api *)channel->dev->api;
 
        if (api->send == NULL) {
                return -ENOSYS;
        }
 
        return api->send(channel->dev, channel->id, msg);
}
 
static inline int mbox_register_callback(const struct mbox_channel *channel,
                                         mbox_callback_t cb,
                                         void *user_data)
{
        const struct mbox_driver_api *api =
                (const struct mbox_driver_api *)channel->dev->api;
 
        if (api->register_callback == NULL) {
                return -ENOSYS;
        }
 
        return api->register_callback(channel->dev, channel->id, cb, user_data);
}
 
__syscall int mbox_mtu_get(const struct device *dev);
 
static inline int z_impl_mbox_mtu_get(const struct device *dev)
{
        const struct mbox_driver_api *api =
                (const struct mbox_driver_api *)dev->api;
 
        if (api->mtu_get == NULL) {
                return -ENOSYS;
        }
 
        return api->mtu_get(dev);
}
 
__syscall int mbox_set_enabled(const struct mbox_channel *channel, bool enable);
 
static inline int z_impl_mbox_set_enabled(const struct mbox_channel *channel, bool enable)
{
        const struct mbox_driver_api *api =
                (const struct mbox_driver_api *)channel->dev->api;
 
        if (api->set_enabled == NULL) {
                return -ENOSYS;
        }
 
        return api->set_enabled(channel->dev, channel->id, enable);
}
 
__syscall uint32_t mbox_max_channels_get(const struct device *dev);
 
static inline uint32_t z_impl_mbox_max_channels_get(const struct device *dev)
{
        const struct mbox_driver_api *api =
                (const struct mbox_driver_api *)dev->api;
 
        if (api->max_channels_get == NULL) {
                return -ENOSYS;
        }
 
        return api->max_channels_get(dev);
}
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/mbox.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MBOX_H_ */