Shell remote

Shell remote API. More...

Files
file	shell_remote.h
	Support for remote clients.
file	shell_remote_cli.h
	APIs for the remote shell client.
file	shell_remote_common.h
	Common APIs for the remote shell.

Data Structures
struct	shell_remote_cmd
	Structure to store the data for the remote shell command. More...
struct	shell_remote_data
	Structure to store the data for the remote shell instance. More...
struct	shell_remote
	Structure to store the configuration for the remote shell instance. More...

Macros
#define	CONFIG_SHELL_REMOTE_TMP_BUF_SIZE   128
	Default size of the temporary buffer for remote shell command data.
#define	SHELL_REMOTE_CONN(_name, ipc_node)
	Macro to define a remote shell instance.

Functions
void	shell_remote_ep_bound (void *priv)
	Callback function to handle the bound event of the remote shell instance.
void	shell_remote_ep_recv (const void *data, size_t len, void *priv)
	Callback function to handle the received event of the remote shell instance.

Detailed Description

Shell remote API.

Macro Definition Documentation

CONFIG_SHELL_REMOTE_TMP_BUF_SIZE

#define CONFIG_SHELL_REMOTE_TMP_BUF_SIZE   128

#include <shell_remote.h>

Default size of the temporary buffer for remote shell command data.

SHELL_REMOTE_CONN

#define SHELL_REMOTE_CONN	(		_name,
			ipc_node )

#include <shell_remote.h>

Value:

static struct shell_remote_data shell_remote_data_##_name;                                 \
static const STRUCT_SECTION_ITERABLE(shell_remote, _name) = {                              \
        .name = STRINGIFY(_name), .ipc = DEVICE_DT_GET(ipc_node),                          \
                          .ep_cfg = {.name = CONFIG_SHELL_REMOTE_EP_NAME,                  \
                                     .cb =                                                 \
                                             {                                             \
                                                     .bound = shell_remote_ep_bound,       \
                                                     .received = shell_remote_ep_recv,     \
                                             },                                            \
                                     .priv = &shell_remote_data_##_name}}

Macro to define a remote shell instance.

Parameters

_name	Name of the remote shell instance (command syntax).
ipc_node	Device node for the IPC device.

Function Documentation

shell_remote_ep_bound()

void shell_remote_ep_bound

(

void *

priv

)

#include <shell_remote.h>

Callback function to handle the bound event of the remote shell instance.

Parameters

priv	Pointer to the private data.

shell_remote_ep_recv()

void shell_remote_ep_recv	(	const void *	data,
		size_t	len,
		void *	priv )

#include <shell_remote.h>

Callback function to handle the received event of the remote shell instance.

Parameters

data	Pointer to the data.
len	Length of the data.
priv	Pointer to the private data.