0e4efdb2a6
This commit adds a test that checks if disconnecting and restarting the IPC session works correctly. The test is also focused on the "unbound" callback. Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no> Co-authored-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no>
169 lines
5.4 KiB
C
169 lines
5.4 KiB
C
/*
|
|
* 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 "pbuf_v1.h"
|
|
#include <zephyr/sys/atomic.h>
|
|
|
|
/* Config aliases that prevenets from config collisions: */
|
|
#undef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC
|
|
#ifdef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC_V1
|
|
#define CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_SYNC_V1
|
|
#endif
|
|
#undef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_TO_MS
|
|
#ifdef CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_TO_MS_V1
|
|
#define CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_TO_MS CONFIG_IPC_SERVICE_ICMSG_SHMEM_ACCESS_TO_MS_V1
|
|
#endif
|
|
#undef CONFIG_IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS
|
|
#ifdef CONFIG_IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS_V1
|
|
#define CONFIG_IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS \
|
|
CONFIG_IPC_SERVICE_ICMSG_BOND_NOTIFY_REPEAT_TO_MS_V1
|
|
#endif
|
|
#undef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_ENABLE
|
|
#ifdef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_ENABLE_V1
|
|
#define CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_ENABLE CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_ENABLE_V1
|
|
#endif
|
|
#undef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_STACK_SIZE
|
|
#ifdef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_STACK_SIZE_V1
|
|
#define CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_STACK_SIZE \
|
|
CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_STACK_SIZE_V1
|
|
#endif
|
|
#undef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_PRIORITY
|
|
#ifdef CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_PRIORITY_V1
|
|
#define CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_PRIORITY CONFIG_IPC_SERVICE_BACKEND_ICMSG_WQ_PRIORITY_V1
|
|
#endif
|
|
#undef CONFIG_PBUF_RX_READ_BUF_SIZE
|
|
#ifdef CONFIG_PBUF_RX_READ_BUF_SIZE_V1
|
|
#define CONFIG_PBUF_RX_READ_BUF_SIZE CONFIG_PBUF_RX_READ_BUF_SIZE_V1
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Icmsg IPC library API
|
|
* @defgroup ipc_icmsg_api Icmsg IPC library API
|
|
* @ingroup ipc
|
|
* @{
|
|
*/
|
|
|
|
enum icmsg_state {
|
|
ICMSG_STATE_OFF,
|
|
ICMSG_STATE_BUSY,
|
|
ICMSG_STATE_READY,
|
|
};
|
|
|
|
struct icmsg_config_t {
|
|
struct mbox_dt_spec mbox_tx;
|
|
struct mbox_dt_spec mbox_rx;
|
|
};
|
|
|
|
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_delayable notify_work;
|
|
struct k_work mbox_work;
|
|
#endif
|
|
atomic_t state;
|
|
};
|
|
|
|
/** @brief Open an icmsg instance
|
|
*
|
|
* Open an icmsg instance to be able to send and receive messages to a remote
|
|
* instance.
|
|
* This function is blocking until the handshake with the remote instance is
|
|
* completed.
|
|
* This function is intended to be called late in the initialization process,
|
|
* possibly from a thread which can be safely blocked while handshake with the
|
|
* remote instance is being pefromed.
|
|
*
|
|
* @param[in] conf Structure containing configuration parameters for the icmsg
|
|
* instance.
|
|
* @param[inout] dev_data Structure containing run-time data used by the icmsg
|
|
* instance.
|
|
* @param[in] cb Structure containing callback functions to be called on
|
|
* events generated by this icmsg instance. The pointed memory
|
|
* must be preserved while the icmsg instance is active.
|
|
* @param[in] ctx Pointer to context passed as an argument to callbacks.
|
|
*
|
|
*
|
|
* @retval 0 on success.
|
|
* @retval -EALREADY when the instance is already opened.
|
|
* @retval other errno codes from dependent modules.
|
|
*/
|
|
int icmsg_open(const struct icmsg_config_t *conf,
|
|
struct icmsg_data_t *dev_data,
|
|
const struct ipc_service_cb *cb, void *ctx);
|
|
|
|
/** @brief Close an icmsg instance
|
|
*
|
|
* Closing an icmsg instance results in releasing all resources used by given
|
|
* instance including the shared memory regions and mbox devices.
|
|
*
|
|
* @param[in] conf Structure containing configuration parameters for the icmsg
|
|
* instance being closed. Its content must be the same as used
|
|
* for creating this instance with @ref icmsg_open.
|
|
* @param[inout] dev_data Structure containing run-time data used by the icmsg
|
|
* instance.
|
|
*
|
|
* @retval 0 on success.
|
|
* @retval other errno codes from dependent modules.
|
|
*/
|
|
int icmsg_close(const struct icmsg_config_t *conf,
|
|
struct icmsg_data_t *dev_data);
|
|
|
|
/** @brief Send a message to the remote icmsg instance.
|
|
*
|
|
* @param[in] conf Structure containing configuration parameters for the icmsg
|
|
* instance.
|
|
* @param[inout] dev_data Structure containing run-time data used by the icmsg
|
|
* instance.
|
|
* @param[in] msg Pointer to a buffer containing data to send.
|
|
* @param[in] len Size of data in the @p msg buffer.
|
|
*
|
|
*
|
|
* @retval Number of sent bytes.
|
|
* @retval -EBUSY when the instance has not finished handshake with the remote
|
|
* instance.
|
|
* @retval -ENODATA when the requested data to send is empty.
|
|
* @retval -EBADMSG when the requested data to send is too big.
|
|
* @retval -ENOBUFS when there are no TX buffers available.
|
|
* @retval other errno codes from dependent modules.
|
|
*/
|
|
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_ */
|