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/ipc/pbuf.h>
#include <zephyr/sys/atomic.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum icmsg_state {
        ICMSG_STATE_OFF,
 
        ICMSG_STATE_INITIALIZING_SID_DISABLED,
 
        ICMSG_STATE_INITIALIZING_SID_ENABLED,
 
        ICMSG_STATE_INITIALIZING_SID_DETECT,
 
        ICMSG_STATE_DISCONNECTED,
 
        /* Connected states must be at the end. */
 
        ICMSG_STATE_CONNECTED_SID_DISABLED,
 
        ICMSG_STATE_CONNECTED_SID_ENABLED,
};
 
enum icmsg_unbound_mode {
        ICMSG_UNBOUND_MODE_DISABLE = ICMSG_STATE_INITIALIZING_SID_DISABLED,
        ICMSG_UNBOUND_MODE_ENABLE = ICMSG_STATE_INITIALIZING_SID_ENABLED,
        ICMSG_UNBOUND_MODE_DETECT = ICMSG_STATE_INITIALIZING_SID_DETECT,
};
 
struct icmsg_config_t {
        struct mbox_dt_spec mbox_tx;
        struct mbox_dt_spec mbox_rx;
        enum icmsg_unbound_mode unbound_mode;
};
 
struct icmsg_data_t {
        /* Tx/Rx buffers. */
        struct pbuf *tx_pb;
        struct pbuf *rx_pb;
#ifdef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC
        struct k_mutex tx_lock;
#endif
 
        /* Callbacks for an endpoint. */
        const struct ipc_service_cb *cb;
        void *ctx;
 
        /* General */
        const struct icmsg_config_t *cfg;
#ifdef CONFIG_MULTITHREADING
        struct k_work mbox_work;
#endif
        uint16_t remote_sid;
        uint16_t local_sid;
        atomic_t state;
};
 
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);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_IPC_ICMSG_H_ */