Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
shell_ctx Struct Reference

Shell instance context. More...

#include <shell.h>

Data Fields

const char * prompt
 
enum shell_state state
 
enum shell_receive_state receive_state
 
struct shell_static_entry active_cmd
 
const struct shell_static_entryselected_cmd
 
struct shell_vt100_ctx vt100_ctx
 
shell_uninit_cb_t uninit_cb
 
shell_bypass_cb_t bypass
 
uint16_t cmd_buff_len
 
uint16_t cmd_buff_pos
 
uint16_t cmd_tmp_buff_len
 
char cmd_buff [0]
 
char temp_buff [0]
 
char printf_buff [0]
 
volatile union shell_internal internal
 
struct k_poll_signal signals [SHELL_SIGNALS]
 
struct k_poll_event events [SHELL_SIGNALS]
 
struct k_mutex wr_mtx
 
k_tid_t tid
 

Detailed Description

Shell instance context.

Field Documentation

◆ active_cmd

struct shell_static_entry shell_ctx::active_cmd

◆ bypass

shell_bypass_cb_t shell_ctx::bypass

◆ cmd_buff

char shell_ctx::cmd_buff[0]

Command temporary buffer.

◆ cmd_buff_len

uint16_t shell_ctx::cmd_buff_len

Command length.

◆ cmd_buff_pos

uint16_t shell_ctx::cmd_buff_pos

Command buffer cursor position.

◆ cmd_tmp_buff_len

uint16_t shell_ctx::cmd_tmp_buff_len

Command length in tmp buffer. Command input buffer.

◆ events

struct k_poll_event shell_ctx::events[SHELL_SIGNALS]

◆ internal

volatile union shell_internal shell_ctx::internal

Internal shell data.

◆ printf_buff

char shell_ctx::printf_buff[0]

◆ prompt

const char* shell_ctx::prompt

shell current prompt.

◆ receive_state

enum shell_receive_state shell_ctx::receive_state

Escape sequence indicator. Currently executed command.

◆ selected_cmd

const struct shell_static_entry* shell_ctx::selected_cmd

VT100 color and cursor position, terminal width.

◆ signals

struct k_poll_signal shell_ctx::signals[SHELL_SIGNALS]

◆ state

enum shell_state shell_ctx::state

Internal module state.

◆ temp_buff

char shell_ctx::temp_buff[0]

Printf buffer size.

◆ tid

k_tid_t shell_ctx::tid

◆ uninit_cb

shell_uninit_cb_t shell_ctx::uninit_cb

When bypass is set, all incoming data is passed to the callback.

◆ vt100_ctx

struct shell_vt100_ctx shell_ctx::vt100_ctx

Callback called from shell thread context when unitialization is completed just before aborting shell thread.

◆ wr_mtx

struct k_mutex shell_ctx::wr_mtx

The documentation for this struct was generated from the following file: