shell_rpmsg Struct Reference

RPMsg-based shell transport. More...

#include <shell_rpmsg.h>

Data Fields
shell_transport_handler_t	shell_handler
	Handler function registered by shell.
void *	shell_context
	Context registered by shell.
bool	ready
	Indicator if we are ready to read/write.
bool	blocking
	Setting for blocking mode.
struct rpmsg_endpoint	ept
	RPMsg endpoint.
struct k_msgq	rx_q
	Queue for received data.
struct shell_rpmsg_rx	rx_buf [CONFIG_SHELL_RPMSG_MAX_RX]
	Buffer for received messages.
struct shell_rpmsg_rx	rx_cur
	The current rx message.
size_t	rx_consumed
	The number of bytes consumed from rx_cur.

Detailed Description

RPMsg-based shell transport.

Field Documentation

blocking

bool shell_rpmsg::blocking

Setting for blocking mode.

ept

struct rpmsg_endpoint shell_rpmsg::ept

RPMsg endpoint.

ready

bool shell_rpmsg::ready

Indicator if we are ready to read/write.

rx_buf

struct shell_rpmsg_rx shell_rpmsg::rx_buf[CONFIG_SHELL_RPMSG_MAX_RX]

Buffer for received messages.

rx_consumed

size_t shell_rpmsg::rx_consumed

The number of bytes consumed from rx_cur.

rx_cur

struct shell_rpmsg_rx shell_rpmsg::rx_cur

The current rx message.

rx_q

struct k_msgq shell_rpmsg::rx_q

Queue for received data.

shell_context

void* shell_rpmsg::shell_context

Context registered by shell.

shell_handler

shell_transport_handler_t shell_rpmsg::shell_handler

Handler function registered by shell.

---

The documentation for this struct was generated from the following file:

• include/zephyr/shell/shell_rpmsg.h