mailbox.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
/*
 * Author: Andreas Werner <kernel@andy89.org>
 * Date: 2016
 */
#ifndef MAILBOX_H_
#define MAILBOX_H_
#include <FreeRTOS.h>
#include <stdint.h>
#include <stdbool.h>
#include <system.h>
#include <semphr.h>
#include <hal.h>
struct mailbox;
#ifdef CONFIG_MAILBOX_MULTI
 
struct mailbox_ops {
        struct mailbox *(*mailbox_init)(uint32_t index);
        int32_t (*mailbox_deinit)(struct mailbox *mailbox);
        int32_t (*mailbox_send)(struct mailbox *mailbox, uint32_t data, TickType_t waittime);
        int32_t (*mailbox_recv)(struct mailbox *mailbox, uint32_t *data, TickType_t waittime);
        int32_t (*mailbox_sendISR)(struct mailbox *mailbox, uint32_t data);
        int32_t (*mailbox_recvISR)(struct mailbox *mailbox, uint32_t *data);
};
#endif
 
struct mailbox_generic {
        bool init;
#ifdef CONFIG_INSTANCE_NAME
 
        const char *name;
#endif
#ifdef CONFIG_MAILBOX_THREAD_SAVE
 
        OS_DEFINE_MUTEX_RECURSIVE(lock);
#endif
#ifdef CONFIG_MAILBOX_MULTI
 
        const struct mailbox_ops *ops;
#endif
};
#ifndef CONFIG_MAILBOX_MULTI
 
struct mailbox *mailbox_init(uint32_t index);
int32_t mailbox_deinit(struct mailbox *mailbox);
int32_t mailbox_send(struct mailbox *mailbox, uint32_t data, TickType_t waittime);
int32_t mailbox_recv(struct mailbox *mailbox, uint32_t *data, TickType_t waittime);
int32_t mailbox_sendISR(struct mailbox *mailbox, uint32_t data);
int32_t mailbox_recvISR(struct mailbox *mailbox, uint32_t *data);
#else
inline struct mailbox *mailbox_init(uint32_t index) {
        HAL_DEFINE_GLOBAL_ARRAY(mailbox);
        struct mailbox_generic *p = (struct mailbox_generic *) HAL_GET_DEV(mailbox, index);
        if (p == NULL) {
                return NULL;
        }
        return p->ops->mailbox_init(index);
}
inline int32_t mailbox_deinit(struct mailbox *mailbox) {
        struct mailbox_generic *p = (struct mailbox_generic *) mailbox;
        return p->ops->mailbox_deinit(mailbox);
}
inline int32_t mailbox_send(struct mailbox *mailbox, uint32_t data, TickType_t waittime) {
        struct mailbox_generic *p = (struct mailbox_generic *) mailbox;
        return p->ops->mailbox_send(mailbox, data, waittime);
}
inline int32_t mailbox_recv(struct mailbox *mailbox, uint32_t *data, TickType_t waittime) {
        struct mailbox_generic *p = (struct mailbox_generic *) mailbox;
        return p->ops->mailbox_recv(mailbox, data, waittime);
}
inline int32_t mailbox_sendISR(struct mailbox *mailbox, uint32_t data) {
        struct mailbox_generic *p = (struct mailbox_generic *) mailbox;
        return p->ops->mailbox_sendISR(mailbox, data);
}
inline int32_t mailbox_recvISR(struct mailbox *mailbox, uint32_t *data) {
        struct mailbox_generic *p = (struct mailbox_generic *) mailbox;
        return p->ops->mailbox_recvISR(mailbox, data);
}
#endif
 
#endif