Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] Fix console echo handling #2233

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[RFC] Fix console echo handling #2233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a9108a
sys/console: Allow to disable NLIP in console
kasjer Mar 9, 2020
ae6bfbc
sys/console: Fix console to respect echo request
kasjer Mar 9, 2020
1c35795
sys/console: Make echo of LF optional in silenced NLIP
kasjer Mar 9, 2020
5abaebe
sys/console: Don't show prompt when echo is off
kasjer Mar 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 52 additions & 27 deletions sys/console/full/src/console.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ static struct os_eventq compat_lines_queue;
static int esc_state;
static int nlip_state;
static int echo = MYNEWT_VAL(CONSOLE_ECHO);
static int console_is_interactive = MYNEWT_VAL(CONSOLE_ECHO);
static unsigned int ansi_val, ansi_val_2;
static bool rx_stalled;

Expand Down Expand Up @@ -128,6 +129,7 @@ console_out_nolock(int c)
void
console_echo(int on)
{
console_is_interactive = on;
echo = on;
}

Expand Down Expand Up @@ -469,6 +471,10 @@ console_prompt_set(const char *prompt, const char *line)
}
trailing_chars = 0;

if (!console_is_interactive) {
return;
}

locked = console_lock(1000) == OS_OK;

console_switch_to_prompt();
Expand Down Expand Up @@ -517,31 +523,33 @@ console_write(const char *str, int cnt)
return;
}

if (cnt >= 2 && str[0] == CONSOLE_NLIP_DATA_START1 &&
str[1] == CONSOLE_NLIP_DATA_START2) {
g_is_output_nlip = 1;
}
if (MYNEWT_VAL(CONSOLE_NLIP)) {
if (cnt >= 2 && str[0] == CONSOLE_NLIP_DATA_START1 &&
str[1] == CONSOLE_NLIP_DATA_START2) {
g_is_output_nlip = 1;
}

/* From the shell the first byte is always \n followed by the
* actual pkt start bytes, hence checking byte 1 and 2
*/
if (cnt >= 3 && str[1] == CONSOLE_NLIP_PKT_START1 &&
str[2] == CONSOLE_NLIP_PKT_START2) {
g_is_output_nlip = 1;
}
/* From the shell the first byte is always \n followed by the
* actual pkt start bytes, hence checking byte 1 and 2
*/
if (cnt >= 3 && str[1] == CONSOLE_NLIP_PKT_START1 &&
str[2] == CONSOLE_NLIP_PKT_START2) {
g_is_output_nlip = 1;
}

/* If the byte string is non nlip and we are silencing non nlip bytes,
* do not let it go out on the console
*/
if (!g_is_output_nlip && g_console_silence_non_nlip) {
goto done;
/* If the byte string is non nlip and we are silencing non nlip bytes,
* do not let it go out on the console
*/
if (!g_is_output_nlip && g_console_silence_non_nlip) {
goto done;
}
}

console_switch_to_logs();
console_filter_write(str, cnt);

done:
if (cnt > 0 && str[cnt - 1] == '\n') {
if (MYNEWT_VAL(CONSOLE_NLIP) && cnt > 0 && str[cnt - 1] == '\n') {
g_is_output_nlip = 0;
}
(void)console_unlock();
Expand Down Expand Up @@ -672,7 +680,7 @@ insert_char(char *pos, char c)
return;
}

if (echo) {
if (console_is_interactive) {
if (!MYNEWT_VAL_CHOICE(CONSOLE_HISTORY, none) &&
MYNEWT_VAL(CONSOLE_HISTORY_AUTO_SEARCH) && trailing_selection) {
cursor_clear_line();
Expand Down Expand Up @@ -700,7 +708,7 @@ insert_char(char *pos, char c)
end = trailing_chars;

while (end-- > 0) {
if (echo) {
if (console_is_interactive) {
console_out_nolock(tmp);
}
c = *pos;
Expand All @@ -709,7 +717,7 @@ insert_char(char *pos, char c)
}

/* Move cursor back to right place */
if (echo) {
if (console_is_interactive) {
cursor_backward(trailing_chars);
}
}
Expand Down Expand Up @@ -981,7 +989,7 @@ handle_nlip(uint8_t byte)
insert_char(&input->line[cur], byte);
if (byte == '\n') {
input->line[cur] = '\0';
console_echo(1);
console_is_interactive = echo;
nlip_state = 0;

console_handle_line();
Expand All @@ -991,7 +999,7 @@ handle_nlip(uint8_t byte)
if (byte == CONSOLE_NLIP_PKT_START2) {
nlip_state = NLIP_PKT_START2;
/* Disable echo to not flood the UART */
console_echo(0);
console_is_interactive = 0;
insert_char(&input->line[cur], CONSOLE_NLIP_PKT_START1);
insert_char(&input->line[cur], CONSOLE_NLIP_PKT_START2);
} else {
Expand All @@ -1003,7 +1011,7 @@ handle_nlip(uint8_t byte)
if (byte == CONSOLE_NLIP_DATA_START2) {
nlip_state = NLIP_DATA_START2;
/* Disable echo to not flood the UART */
console_echo(0);
console_is_interactive = 0;
insert_char(&input->line[cur], CONSOLE_NLIP_DATA_START1);
insert_char(&input->line[cur], CONSOLE_NLIP_DATA_START2);
} else {
Expand All @@ -1017,8 +1025,15 @@ handle_nlip(uint8_t byte)
} else if (byte == CONSOLE_NLIP_PKT_START1) {
nlip_state = NLIP_PKT_START1;
} else {
/* For old code compatibility end of lines characters pass through */
handled = g_console_ignore_non_nlip && byte != '\r' && byte != '\n';
if (!g_console_ignore_non_nlip) {
handled = 0;
} else if ((byte == '\r' || byte == '\n') && MYNEWT_VAL(CONSOLE_NLIP_ECHO_LF)) {
/* For old code compatibility end of lines characters pass through */
if (0 == console_lock(1000)) {
console_out_nolock(byte);
console_unlock();
}
}
}
break;
}
Expand All @@ -1039,7 +1054,7 @@ console_append_char(char *line, uint8_t byte)
return 1;
}

if (echo) {
if (console_is_interactive) {
/* Echo back to console */
console_switch_to_prompt();
console_out_nolock(byte);
Expand Down Expand Up @@ -1082,7 +1097,17 @@ console_handle_char(uint8_t byte)
}
input = current_line_ev->ev_arg;

if (handle_nlip(byte)) {
if (MYNEWT_VAL(CONSOLE_NLIP) && handle_nlip(byte)) {
return 0;
}

if (!console_is_interactive) {
if (byte == '\r' || byte == '\n') {
input->line[cur + trailing_chars] = '\0';
console_handle_line();
} else {
insert_char(&input->line[cur], byte);
}
return 0;
}

Expand Down
10 changes: 10 additions & 0 deletions sys/console/full/syscfg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ syscfg.defs:
CONSOLE_ECHO:
description: 'Default console echo'
value: 1
CONSOLE_NLIP:
description: 'Enable NLIP handling in console code'
value: 1
CONSOLE_NLIP_ECHO_LF:
description: >
Enable LF echo even if function console_ignore_non_nlip()
was called to ignore any non NLIP input. This allows for
simple check if application is running correctly
by using simple terminal.
value: 0
CONSOLE_COMPAT:
description: 'Console backward compatibility'
value: 1
Expand Down
54 changes: 32 additions & 22 deletions sys/console/minimal/src/console.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ static struct os_eventq compat_lines_queue;

static int nlip_state;
static int echo = MYNEWT_VAL(CONSOLE_ECHO);
static int console_is_interactive = MYNEWT_VAL(CONSOLE_ECHO);

static uint8_t cur, end;
static struct os_eventq *avail_queue;
Expand All @@ -72,6 +73,7 @@ void
console_echo(int on)
{
echo = on;
console_is_interactive = on;
}

int
Expand Down Expand Up @@ -132,6 +134,10 @@ console_out(int c)
void
console_prompt_set(const char *prompt, const char *line)
{
if (!console_is_interactive) {
return;
}

console_write(prompt, strlen(prompt));
if (line) {
console_write(line, strlen(line));
Expand All @@ -149,25 +155,27 @@ console_write(const char *str, int cnt)
return;
}

if (cnt >= 2 && str[0] == CONSOLE_NLIP_DATA_START1 &&
str[1] == CONSOLE_NLIP_DATA_START2) {
g_is_output_nlip = 1;
}
if (MYNEWT_VAL(CONSOLE_NLIP)) {
if (cnt >= 2 && str[0] == CONSOLE_NLIP_DATA_START1 &&
str[1] == CONSOLE_NLIP_DATA_START2) {
g_is_output_nlip = 1;
}

/* From the shell the first byte is always \n followed by the
* actual pkt start bytes, hence checking byte 1 and 2
*/
if (cnt >= 3 && str[1] == CONSOLE_NLIP_PKT_START1 &&
str[2] == CONSOLE_NLIP_PKT_START2) {
g_is_output_nlip = 1;
}
/* From the shell the first byte is always \n followed by the
* actual pkt start bytes, hence checking byte 1 and 2
*/
if (cnt >= 3 && str[1] == CONSOLE_NLIP_PKT_START1 &&
str[2] == CONSOLE_NLIP_PKT_START2) {
g_is_output_nlip = 1;
}


/* If the byte string is non nlip and we are silencing non nlip bytes,
* do not let it go out on the console
*/
if (!g_is_output_nlip && g_console_silence_non_nlip) {
goto done;
/* If the byte string is non nlip and we are silencing non nlip bytes,
* do not let it go out on the console
*/
if (!g_is_output_nlip && g_console_silence_non_nlip) {
goto done;
}
}

for (i = 0; i < cnt; i++) {
Expand All @@ -177,7 +185,7 @@ console_write(const char *str, int cnt)
}

done:
if (cnt > 0 && str[cnt - 1] == '\n') {
if (MYNEWT_VAL(CONSOLE_NLIP) && cnt > 0 && str[cnt - 1] == '\n') {
g_is_output_nlip = 0;
}
(void)console_unlock();
Expand Down Expand Up @@ -238,7 +246,7 @@ insert_char(char *pos, char c, uint8_t end)
return;
}

if (echo) {
if (console_is_interactive) {
/* Echo back to console */
console_out(c);
}
Expand Down Expand Up @@ -296,7 +304,7 @@ console_handle_char(uint8_t byte)
input = ev->ev_arg;
}

if (handle_nlip(byte)) {
if (MYNEWT_VAL(CONSOLE_NLIP) && handle_nlip(byte)) {
if (byte == '\n') {
insert_char(&input->line[cur], byte, end);
input->line[cur] = '\0';
Expand All @@ -313,16 +321,16 @@ console_handle_char(uint8_t byte)

input = NULL;
ev = NULL;
console_echo(1);
console_is_interactive = echo;
return 0;
/* Ignore characters if there's no more buffer space */
} else if (byte == CONSOLE_NLIP_PKT_START2) {
/* Disable echo to not flood the UART */
console_echo(0);
console_is_interactive = 0;
insert_char(&input->line[cur], CONSOLE_NLIP_PKT_START1, end);
} else if (byte == CONSOLE_NLIP_DATA_START2) {
/* Disable echo to not flood the UART */
console_echo(0);
console_is_interactive = 0;
insert_char(&input->line[cur], CONSOLE_NLIP_DATA_START1, end);
}

Expand All @@ -334,12 +342,14 @@ console_handle_char(uint8_t byte)
/* Handle special control characters */
if (!isprint(byte)) {
switch (byte) {
#if MYNEWT_VAL(CONSOLE_NLIP)
case CONSOLE_NLIP_PKT_START1:
nlip_state |= NLIP_PKT_START1;
break;
case CONSOLE_NLIP_DATA_START1:
nlip_state |= NLIP_DATA_START1;
break;
#endif
default:
insert_char(&input->line[cur], byte, end);
/* Falls through. */
Expand Down
3 changes: 3 additions & 0 deletions sys/console/minimal/syscfg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ syscfg.defs:
CONSOLE_ECHO:
description: 'Default console echo'
value: 1
CONSOLE_NLIP:
description: 'Enable NLIP handling in console code'
value: 1
CONSOLE_COMPAT:
description: 'Console backward compatibility'
value: 1
Expand Down