shell_remote_cli.h File Reference

APIs for the remote shell client. More...

#include <zephyr/sys/cbprintf.h>
#include <zephyr/shell/shell.h>

Go to the source code of this file.

Macros
#define	SHELL_REMOTE_CLI_ALIGN   sizeof(long long)
	Alignment for the cbprintf package for the remote shell CLI.
#define	SHELL_REMOTE_CLI_FPRINTF(_sh, _color, ...)
	Print a formatted string to the remote shell.

Functions
void	shell_remote_cli_cbpprintf (const struct shell *sh, enum shell_vt100_color color, void *package, size_t len)
	Print a formatted string to the remote shell.
void	shell_remote_cmd_process (void)
	Process the remote message in the main context when CONFIG_MULTITHREADING is disabled.

Detailed Description

APIs for the remote shell client.

Macro Definition Documentation

SHELL_REMOTE_CLI_ALIGN

#define SHELL_REMOTE_CLI_ALIGN   sizeof(long long)

Alignment for the cbprintf package for the remote shell CLI.

SHELL_REMOTE_CLI_FPRINTF

#define SHELL_REMOTE_CLI_FPRINTF	(		_sh,
			_color,
			... )

Value:

do {                                                                                       \
        int _plen;                                                                         \
        void *_pkg;                                                                        \
        uint32_t _options =                                                                \
                CBPRINTF_PACKAGE_ADD_RO_STR_POS | CBPRINTF_PACKAGE_ADD_RW_STR_POS;         \
        CBPRINTF_STATIC_PACKAGE(NULL, 0, _plen, SHELL_REMOTE_CLI_ALIGN, _options,          \
                                __VA_ARGS__);                                              \
        _pkg = __builtin_alloca_with_align(_plen, 8);                                      \
        CBPRINTF_STATIC_PACKAGE(_pkg, _plen, _plen, SHELL_REMOTE_CLI_ALIGN, _options,      \
                                __VA_ARGS__);                                              \
        shell_remote_cli_cbpprintf(_sh, _color, _pkg, _plen);                              \
} while (0)

Print a formatted string to the remote shell.

Macro is using static packaging to build a package. Space is allocated on the stack.

Parameters

_sh	The shell to print to
_color	The color of the text
...	The formatted string

Function Documentation

shell_remote_cli_cbpprintf()

void shell_remote_cli_cbpprintf	(	const struct shell *	sh,
		enum shell_vt100_color	color,
		void *	package,
		size_t	len )

Print a formatted string to the remote shell.

Parameters

[in]	sh	Pointer to the shell instance.
[in]	color	Printed text color.
[in]	package	Pointer to the package.
[in]	len	Length of the package.

shell_remote_cmd_process()

void shell_remote_cmd_process

(

void

)

Process the remote message in the main context when CONFIG_MULTITHREADING is disabled.