icmsg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_IPC_ICMSG_H_
#define ZEPHYR_INCLUDE_IPC_ICMSG_H_
 
#include <stddef.h>
#include <stdint.h>
#include <zephyr/kernel.h>
#include <zephyr/drivers/mbox.h>
#include <zephyr/ipc/ipc_service.h>
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/spsc_pbuf.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum icmsg_state {
        ICMSG_STATE_OFF,
        ICMSG_STATE_BUSY,
        ICMSG_STATE_READY,
};
 
struct icmsg_config_t {
        uintptr_t tx_shm_addr;
        uintptr_t rx_shm_addr;
        size_t tx_shm_size;
        size_t rx_shm_size;
        struct mbox_channel mbox_tx;
        struct mbox_channel mbox_rx;
};
 
struct icmsg_data_t {
        /* Tx/Rx buffers. */
        struct spsc_pbuf *tx_ib;
        struct spsc_pbuf *rx_ib;
        atomic_t send_buffer_reserved;
#ifdef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC
        struct k_mutex send;
#endif
 
        /* Callbacks for an endpoint. */
        const struct ipc_service_cb *cb;
        void *ctx;
 
        /* General */
        const struct icmsg_config_t *cfg;
        struct k_work_delayable notify_work;
        struct k_work mbox_work;
        atomic_t state;
        uint8_t rx_buffer[CONFIG_IPC_SERVICE_ICMSG_CB_BUF_SIZE] __aligned(4);
 
        /* No-copy */
#ifdef CONFIG_IPC_SERVICE_ICMSG_NOCOPY_RX
        atomic_t rx_buffer_held;
#endif
};
 
int icmsg_open(const struct icmsg_config_t *conf,
               struct icmsg_data_t *dev_data,
               const struct ipc_service_cb *cb, void *ctx);
 
int icmsg_close(const struct icmsg_config_t *conf,
                struct icmsg_data_t *dev_data);
 
int icmsg_send(const struct icmsg_config_t *conf,
               struct icmsg_data_t *dev_data,
               const void *msg, size_t len);
 
int icmsg_get_tx_buffer(const struct icmsg_config_t *conf,
                        struct icmsg_data_t *dev_data,
                        void **data, size_t *size);
 
int icmsg_drop_tx_buffer(const struct icmsg_config_t *conf,
                         struct icmsg_data_t *dev_data,
                         const void *data);
 
int icmsg_send_nocopy(const struct icmsg_config_t *conf,
                      struct icmsg_data_t *dev_data,
                      const void *msg, size_t len);
 
#ifdef CONFIG_IPC_SERVICE_ICMSG_NOCOPY_RX
int icmsg_hold_rx_buffer(const struct icmsg_config_t *conf,
                         struct icmsg_data_t *dev_data,
                         const void *data);
 
int icmsg_release_rx_buffer(const struct icmsg_config_t *conf,
                            struct icmsg_data_t *dev_data,
                            const void *data);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_IPC_ICMSG_H_ */