rpmsg_multi_instance.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_RPMSG_MULTIPLE_INSTANCE_H_
#define ZEPHYR_INCLUDE_RPMSG_MULTIPLE_INSTANCE_H_
 
#include <openamp/open_amp.h>
#include <metal/sys.h>
#include <metal/device.h>
#include <metal/alloc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define VDEV_START_ADDR     CONFIG_RPMSG_MULTI_INSTANCE_SHM_BASE_ADDRESS
#define VDEV_SIZE           CONFIG_RPMSG_MULTI_INSTANCE_SHM_SIZE
 
#define SHM_START_ADDR      VDEV_START_ADDR
#define SHM_SIZE            VDEV_SIZE
 
#define VRING_ALIGNMENT     (4)     
#define VDEV_STATUS_SIZE    (0x4)   
struct rpmsg_mi_cb {
        void (*bound)(void *priv);
 
        void (*received)(const void *data, size_t len, void *priv);
};
 
struct rpmsg_mi_ept {
 
        const char *name;
 
        struct rpmsg_endpoint ep;
 
        struct rpmsg_mi_cb *cb;
 
        void *priv;
 
        volatile bool bound;
 
        sys_snode_t node;
};
 
struct rpmsg_mi_ept_cfg {
 
        const char *name;
 
        struct rpmsg_mi_cb *cb;
 
        void *priv;
};
 
struct rpmsg_mi_ctx {
        const char *name;
        struct k_work_q ipm_work_q;
        struct k_work ipm_work;
 
        const struct device *ipm_tx_handle;
        const struct device *ipm_rx_handle;
 
        unsigned int ipm_tx_id;
 
        uintptr_t shm_status_reg_addr;
        struct metal_io_region *shm_io;
        struct metal_device shm_device;
        metal_phys_addr_t shm_physmap[1];
 
        struct rpmsg_virtio_device rvdev;
        struct rpmsg_virtio_shm_pool shpool;
        struct rpmsg_device *rdev;
 
        struct virtqueue *vq[2];
        struct virtio_vring_info rvrings[2];
        struct virtio_device vdev;
 
        uintptr_t vring_tx_addr;
        uintptr_t vring_rx_addr;
 
        sys_slist_t endpoints;
};
 
struct rpmsg_mi_ctx_shm_cfg {
        uintptr_t addr;
 
        size_t size;
 
        unsigned int instance;
};
 
struct rpmsg_mi_ctx_cfg {
 
        const char *name;
 
        k_thread_stack_t *ipm_stack_area;
 
        size_t ipm_stack_size;
 
        int ipm_work_q_prio;
 
        const char *ipm_thread_name;
 
        const char *ipm_tx_name;
 
        const char *ipm_rx_name;
 
        unsigned int ipm_tx_id;
 
        struct rpmsg_mi_ctx_shm_cfg *shm;
};
 
int rpmsg_mi_ctx_init(struct rpmsg_mi_ctx *ctx, const struct rpmsg_mi_ctx_cfg *cfg);
 
int rpmsg_mi_ept_register(struct rpmsg_mi_ctx *ctx,
                          struct rpmsg_mi_ept *ept,
                          struct rpmsg_mi_ept_cfg *cfg);
 
int rpmsg_mi_send(struct rpmsg_mi_ept *ept, const void *data, size_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_RPMSG_MULTIPLE_INNSTANCE_H_ */