RPMsg shell backend

Shell access over an RPMsg endpoint. More...

Files
file	shell_rpmsg.h
	Header file for the RPMsg shell backend.

Macros
#define	SHELL_RPMSG_DEFINE(_name)
	Define an RPMsg shell transport instance.

Functions
int	shell_backend_rpmsg_init_transport (struct rpmsg_device *rpmsg_dev)
	Initialize the Shell backend using the provided rpmsg_dev device.
const struct shell *	shell_backend_rpmsg_get_ptr (void)
	This function provides pointer to shell RPMsg backend instance.

Detailed Description

Shell access over an RPMsg endpoint.

Macro Definition Documentation

SHELL_RPMSG_DEFINE

#define SHELL_RPMSG_DEFINE

(

_name

)

#include <zephyr/shell/shell_rpmsg.h>

Value:

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

Define an RPMsg shell transport instance.

Parameters

_name

Name of the transport instance.

Function Documentation

shell_backend_rpmsg_get_ptr()

const struct shell * shell_backend_rpmsg_get_ptr

(

void

)

#include <zephyr/shell/shell_rpmsg.h>

This function provides pointer to shell RPMsg backend instance.

Function returns pointer to the shell RPMsg instance. This instance can be next used with shell_execute_cmd function in order to test commands behavior.

Returns

Pointer to the shell instance.

shell_backend_rpmsg_init_transport()

int shell_backend_rpmsg_init_transport

(

struct rpmsg_device *

rpmsg_dev

)

#include <zephyr/shell/shell_rpmsg.h>

Initialize the Shell backend using the provided rpmsg_dev device.

Parameters

rpmsg_dev

A pointer to an RPMsg device

Returns

0 on success or a negative value on error