shell_uart.h File Reference

#include <zephyr/drivers/serial/uart_async_rx.h>
#include <zephyr/mgmt/mcumgr/transport/smp_shell.h>
#include <zephyr/shell/shell.h>

Go to the source code of this file.

Data Structures
struct	shell_uart_common
struct	shell_uart_int_driven
struct	shell_uart_async
struct	shell_uart_polling

Macros
#define	CONFIG_SHELL_BACKEND_SERIAL_RX_RING_BUFFER_SIZE   0
#define	CONFIG_SHELL_BACKEND_SERIAL_TX_RING_BUFFER_SIZE   0
#define	CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_COUNT   0
#define	CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_SIZE   0
#define	ASYNC_RX_BUF_SIZE
#define	SHELL_UART_STRUCT   struct shell_uart_int_driven
#define	SHELL_UART_DEFINE(_name, ...)
	Macro for creating shell UART transport instance named _name.

Functions
const struct shell *	shell_backend_uart_get_ptr (void)
	This function provides pointer to the shell UART backend instance.
struct smp_shell_data *	shell_uart_smp_shell_data_get_ptr (void)
	This function provides pointer to the smp shell data of the UART shell transport.

Variables
const struct shell_transport_api	shell_uart_transport_api

Macro Definition Documentation

ASYNC_RX_BUF_SIZE

#define ASYNC_RX_BUF_SIZE

Value:

                (CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_COUNT * \
                (CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_SIZE + \
                 UART_ASYNC_RX_BUF_OVERHEAD))

CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_COUNT

#define CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_COUNT   0

CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_SIZE

#define CONFIG_SHELL_BACKEND_SERIAL_ASYNC_RX_BUFFER_SIZE   0

CONFIG_SHELL_BACKEND_SERIAL_RX_RING_BUFFER_SIZE

#define CONFIG_SHELL_BACKEND_SERIAL_RX_RING_BUFFER_SIZE   0

CONFIG_SHELL_BACKEND_SERIAL_TX_RING_BUFFER_SIZE

#define CONFIG_SHELL_BACKEND_SERIAL_TX_RING_BUFFER_SIZE   0

SHELL_UART_DEFINE

#define SHELL_UART_DEFINE	(		_name,
			...
	)

Value:

        static SHELL_UART_STRUCT _name##_shell_uart;                                               \
        struct shell_transport _name = {                                                           \
                .api = &shell_uart_transport_api,                                                  \
                .ctx = (struct shell_telnet *)&_name##_shell_uart,                                 \
        }

Macro for creating shell UART transport instance named _name.

Note

Additional arguments are accepted (but ignored) for compatibility with previous Zephyr version, it will be removed in future release.

SHELL_UART_STRUCT

#define SHELL_UART_STRUCT   struct shell_uart_int_driven

Function Documentation

shell_backend_uart_get_ptr()

const struct shell * shell_backend_uart_get_ptr

(

void

)

This function provides pointer to the shell UART backend instance.

Function returns pointer to the shell UART 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_uart_smp_shell_data_get_ptr()

struct smp_shell_data * shell_uart_smp_shell_data_get_ptr

(

void

)

This function provides pointer to the smp shell data of the UART shell transport.

Returns

Pointer to the smp shell data.

Variable Documentation

shell_uart_transport_api

const struct shell_transport_api shell_uart_transport_api

extern