icmsg_me.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_IPC_ICMSG_ME_H_
#define ZEPHYR_INCLUDE_IPC_ICMSG_ME_H_
 
#include <stdint.h>
#include <zephyr/kernel.h>
#include <zephyr/ipc/icmsg.h>
#include <zephyr/ipc/ipc_service.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* If more bytes than 1 was used for endpoint id, endianness should be
 * considered.
 */
typedef uint8_t icmsg_me_ept_id_t;
 
struct icmsg_me_data_t {
        struct icmsg_data_t icmsg_data;
        struct ipc_ept_cfg ept_cfg;
 
        struct k_event event;
 
        struct k_mutex send_mutex;
        const struct ipc_ept_cfg *epts[CONFIG_IPC_SERVICE_BACKEND_ICMSG_ME_NUM_EP];
 
        uint8_t send_buffer[CONFIG_IPC_SERVICE_BACKEND_ICMSG_ME_SEND_BUF_SIZE] __aligned(4);
};
 
 
int icmsg_me_init(const struct icmsg_config_t *conf,
                  struct icmsg_me_data_t *data);
 
int icmsg_me_open(const struct icmsg_config_t *conf,
                  struct icmsg_me_data_t *data,
                  const struct ipc_service_cb *cb,
                  void *ctx);
 
void icmsg_me_wait_for_icmsg_bind(struct icmsg_me_data_t *data);
 
void icmsg_me_icmsg_bound(struct icmsg_me_data_t *data);
 
void icmsg_me_received_data(struct icmsg_me_data_t *data, icmsg_me_ept_id_t id,
                            const void *msg, size_t len);
 
int icmsg_me_set_empty_ept_cfg_slot(struct icmsg_me_data_t *data,
                                    const struct ipc_ept_cfg *ept_cfg,
                                    icmsg_me_ept_id_t *id);
 
int icmsg_me_set_ept_cfg(struct icmsg_me_data_t *data, icmsg_me_ept_id_t id,
                         const struct ipc_ept_cfg *ept_cfg);
 
int icmsg_me_get_ept_cfg(struct icmsg_me_data_t *data, icmsg_me_ept_id_t id,
                         const struct ipc_ept_cfg **ept_cfg);
 
void icmsg_me_reset_ept_cfg(struct icmsg_me_data_t *data, icmsg_me_ept_id_t id);
 
int icmsg_me_send(const struct icmsg_config_t *conf,
                  struct icmsg_me_data_t *data, icmsg_me_ept_id_t id,
                  const void *msg, size_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_IPC_ICMSG_ME_H_ */