shell_rpmsg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Basalte bv
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_SHELL_RPMSG_H_
#define ZEPHYR_INCLUDE_SHELL_RPMSG_H_
 
#include <zephyr/kernel.h>
#include <zephyr/shell/shell.h>
#include <openamp/rpmsg.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern const struct shell_transport_api shell_rpmsg_transport_api;

struct shell_rpmsg_rx {
        void *data;
        size_t len;
};

struct shell_rpmsg {
        shell_transport_handler_t shell_handler;

        void *shell_context;

        bool ready;

        bool blocking;

        struct rpmsg_endpoint ept;

        struct k_msgq rx_q;

        struct shell_rpmsg_rx rx_buf[CONFIG_SHELL_RPMSG_MAX_RX];

        struct shell_rpmsg_rx rx_cur;

        size_t rx_consumed;
};
 
#define SHELL_RPMSG_DEFINE(_name)                                       \
        static struct shell_rpmsg _name##_shell_rpmsg;                  \
        struct shell_transport _name = {                                \
                .api = &shell_rpmsg_transport_api,                      \
                .ctx = (struct shell_rpmsg *)&_name##_shell_rpmsg,      \
        }

int shell_backend_rpmsg_init_transport(struct rpmsg_device *rpmsg_dev);

const struct shell *shell_backend_rpmsg_get_ptr(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SHELL_RPMSG_H_ */