Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
shell_rpmsg.h File Reference
#include <zephyr/kernel.h>
#include <zephyr/shell/shell.h>
#include <openamp/rpmsg.h>

Go to the source code of this file.

Data Structures

struct  shell_rpmsg_rx
 RPMsg received message placeholder. More...
 
struct  shell_rpmsg
 RPMsg-based shell transport. More...
 

Macros

#define SHELL_RPMSG_DEFINE(_name)
 

Functions

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

Variables

const struct shell_transport_api shell_rpmsg_transport_api
 

Macro Definition Documentation

◆ SHELL_RPMSG_DEFINE

#define SHELL_RPMSG_DEFINE (   _name)
Value:
static struct shell_rpmsg _name##_shell_rpmsg; \
struct shell_transport _name = { \
.ctx = (struct shell_rpmsg *)&_name##_shell_rpmsg, \
}
const struct shell_transport_api shell_rpmsg_transport_api
RPMsg-based shell transport.
Definition shell_rpmsg.h:29
Definition shell.h:724
const struct shell_transport_api * api
Definition shell.h:725

Function Documentation

◆ shell_backend_rpmsg_get_ptr()

const struct shell * shell_backend_rpmsg_get_ptr ( void  )

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)

Initialize the Shell backend using the provided rpmsg_dev device.

Parameters
rpmsg_devA pointer to an RPMsg device
Returns
0 on success or a negative value on error

Variable Documentation

◆ shell_rpmsg_transport_api

const struct shell_transport_api shell_rpmsg_transport_api
extern