624 lines
17 KiB
C
624 lines
17 KiB
C
#ifdef FEATURE_SUBSYS_FINSH_ENABLE
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include "shell.h"
|
|
#include "msh.h"
|
|
#include <rtthread.h>
|
|
|
|
/* finsh thread */
|
|
#ifndef RT_USING_HEAP
|
|
static struct rt_thread finsh_thread;
|
|
rt_align(RT_ALIGN_SIZE)
|
|
static char finsh_thread_stack[FINSH_THREAD_STACK_SIZE];
|
|
struct finsh_shell _shell;
|
|
#endif
|
|
|
|
/* finsh symtab */
|
|
#ifdef FINSH_USING_SYMTAB
|
|
struct finsh_syscall *_syscall_table_begin = NULL;
|
|
struct finsh_syscall *_syscall_table_end = NULL;
|
|
#endif
|
|
|
|
struct finsh_shell *shell;
|
|
static char *finsh_prompt_custom = RT_NULL;
|
|
|
|
#if defined(_MSC_VER) || (defined(__GNUC__) && defined(__x86_64__))
|
|
struct finsh_syscall *finsh_syscall_next(struct finsh_syscall *call)
|
|
{
|
|
unsigned int *ptr;
|
|
ptr = (unsigned int *)(call + 1);
|
|
while ((*ptr == 0) && ((unsigned int *)ptr < (unsigned int *) _syscall_table_end))
|
|
ptr ++;
|
|
|
|
return (struct finsh_syscall *)ptr;
|
|
}
|
|
#endif /* defined(_MSC_VER) || (defined(__GNUC__) && defined(__x86_64__)) */
|
|
|
|
#ifdef RT_USING_HEAP
|
|
int finsh_set_prompt(const char *prompt)
|
|
{
|
|
if (finsh_prompt_custom)
|
|
{
|
|
rt_free(finsh_prompt_custom);
|
|
finsh_prompt_custom = RT_NULL;
|
|
}
|
|
|
|
/* strdup */
|
|
if (prompt)
|
|
{
|
|
finsh_prompt_custom = (char *)rt_malloc(strlen(prompt) + 1);
|
|
if (finsh_prompt_custom)
|
|
{
|
|
strcpy(finsh_prompt_custom, prompt);
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
#endif /* RT_USING_HEAP */
|
|
|
|
#define _MSH_PROMPT "msh "
|
|
|
|
const char *finsh_get_prompt(void)
|
|
{
|
|
static char finsh_prompt[RT_CONSOLEBUF_SIZE + 1] = {0};
|
|
/* check prompt mode */
|
|
if (!shell->prompt_mode)
|
|
{
|
|
finsh_prompt[0] = '\0';
|
|
return finsh_prompt;
|
|
}
|
|
if (finsh_prompt_custom)
|
|
{
|
|
strncpy(finsh_prompt, finsh_prompt_custom, sizeof(finsh_prompt) - 1);
|
|
}
|
|
else
|
|
{
|
|
strcpy(finsh_prompt, _MSH_PROMPT);
|
|
}
|
|
strcat(finsh_prompt, ">");
|
|
return finsh_prompt;
|
|
}
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function get the prompt mode of finsh shell.
|
|
*
|
|
* @return prompt the prompt mode, 0 disable prompt mode, other values enable prompt mode.
|
|
*/
|
|
rt_uint32_t finsh_get_prompt_mode(void)
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
return shell->prompt_mode;
|
|
}
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function set the prompt mode of finsh shell.
|
|
*
|
|
* The parameter 0 disable prompt mode, other values enable prompt mode.
|
|
*
|
|
* @param prompt_mode the prompt mode
|
|
*/
|
|
|
|
void finsh_set_prompt_mode(rt_uint32_t prompt_mode)
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
shell->prompt_mode = prompt_mode;
|
|
}
|
|
|
|
int finsh_getchar(void)
|
|
{
|
|
#ifdef FEATURE_SUBSYS_CONSOLE_ENABLE
|
|
extern char ecConsoleGetChar(void);
|
|
return ecConsoleGetChar();
|
|
#endif /* RT_USING_DEVICE */
|
|
}
|
|
|
|
#if !defined(RT_USING_POSIX_STDIO) && defined(RT_USING_DEVICE)
|
|
static rt_err_t finsh_rx_ind(rt_device_t dev, rt_size_t size)
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
/* release semaphore to let finsh thread rx data */
|
|
// rt_sem_release(&shell->rx_sem);
|
|
return RT_EOK;
|
|
}
|
|
rt_int32_t rt_strncmp(const char *cs, const char *ct, rt_size_t count)
|
|
{
|
|
signed char __res = 0;
|
|
while (count)
|
|
{
|
|
if ((__res = *cs - *ct++) != 0 || !*cs++)
|
|
{
|
|
break;
|
|
}
|
|
count --;
|
|
}
|
|
return __res;
|
|
}
|
|
RTM_EXPORT(rt_strncmp);
|
|
rt_size_t rt_strlen(const char *s)
|
|
{
|
|
const char *sc = RT_NULL;
|
|
for (sc = s; *sc != '\0'; ++sc) /* nothing */
|
|
;
|
|
return sc - s;
|
|
}
|
|
RTM_EXPORT(rt_strlen);
|
|
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function sets the input device of finsh shell.
|
|
*
|
|
* @param device_name the name of new input device.
|
|
*/
|
|
void finsh_set_device(const char *device_name)
|
|
{
|
|
rt_device_t dev = RT_NULL;
|
|
RT_ASSERT(shell != RT_NULL);
|
|
// dev = rt_device_find(device_name);
|
|
// if (dev == RT_NULL)
|
|
// {
|
|
// rt_kprintf("finsh: can not find device: %s\n", device_name);
|
|
// return;
|
|
// }
|
|
|
|
// /* check whether it's a same device */
|
|
// if (dev == shell->device) return;
|
|
// /* open this device and set the new device in finsh shell */
|
|
// if (rt_device_open(dev, RT_DEVICE_OFLAG_RDWR | RT_DEVICE_FLAG_INT_RX | \
|
|
// RT_DEVICE_FLAG_STREAM) == RT_EOK)
|
|
// {
|
|
// if (shell->device != RT_NULL)
|
|
// {
|
|
// /* close old finsh device */
|
|
// rt_device_close(shell->device);
|
|
// rt_device_set_rx_indicate(shell->device, RT_NULL);
|
|
// }
|
|
|
|
// /* clear line buffer before switch to new device */
|
|
// memset(shell->line, 0, sizeof(shell->line));
|
|
// shell->line_curpos = shell->line_position = 0;
|
|
|
|
// shell->device = dev;
|
|
// rt_device_set_rx_indicate(dev, finsh_rx_ind);
|
|
// }
|
|
}
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function returns current finsh shell input device.
|
|
*
|
|
* @return the finsh shell input device name is returned.
|
|
*/
|
|
const char *finsh_get_device()
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
return shell->device->parent.name;
|
|
}
|
|
#endif /* !defined(RT_USING_POSIX_STDIO) && defined(RT_USING_DEVICE) */
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function set the echo mode of finsh shell.
|
|
*
|
|
* FINSH_OPTION_ECHO=0x01 is echo mode, other values are none-echo mode.
|
|
*
|
|
* @param echo the echo mode
|
|
*/
|
|
void finsh_set_echo(rt_uint32_t echo)
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
shell->echo_mode = (rt_uint8_t)echo;
|
|
}
|
|
|
|
/**
|
|
* @ingroup finsh
|
|
*
|
|
* This function gets the echo mode of finsh shell.
|
|
*
|
|
* @return the echo mode
|
|
*/
|
|
rt_uint32_t finsh_get_echo()
|
|
{
|
|
RT_ASSERT(shell != RT_NULL);
|
|
|
|
return shell->echo_mode;
|
|
}
|
|
|
|
#ifdef FINSH_USING_AUTH
|
|
/**
|
|
* set a new password for finsh
|
|
*
|
|
* @param password new password
|
|
*
|
|
* @return result, RT_EOK on OK, -RT_ERROR on the new password length is less than
|
|
* FINSH_PASSWORD_MIN or greater than FINSH_PASSWORD_MAX
|
|
*/
|
|
extern void rt_hw_interrupt_enable(rt_base_t level);
|
|
extern rt_base_t rt_hw_interrupt_disable(void);
|
|
rt_err_t finsh_set_password(const char *password)
|
|
{
|
|
rt_base_t level;
|
|
rt_size_t pw_len = rt_strlen(password);
|
|
|
|
if (pw_len < FINSH_PASSWORD_MIN || pw_len > FINSH_PASSWORD_MAX)
|
|
return -RT_ERROR;
|
|
|
|
level = rt_hw_interrupt_disable();
|
|
extern char *rt_strncpy(char *dst, const char *src, rt_size_t n);
|
|
rt_strncpy(shell->password, password, FINSH_PASSWORD_MAX);
|
|
rt_hw_interrupt_enable(level);
|
|
return RT_EOK;
|
|
}
|
|
|
|
/**
|
|
* get the finsh password
|
|
*
|
|
* @return password
|
|
*/
|
|
const char *finsh_get_password(void)
|
|
{
|
|
return shell->password;
|
|
}
|
|
|
|
static void finsh_wait_auth(void)
|
|
{
|
|
int ch;
|
|
rt_bool_t input_finish = RT_FALSE;
|
|
char password[FINSH_PASSWORD_MAX] = { 0 };
|
|
rt_size_t cur_pos = 0;
|
|
/* password not set */
|
|
if (rt_strlen(finsh_get_password()) == 0) return;
|
|
|
|
while (1)
|
|
{
|
|
rt_kprintf("\n\rPassword for login: ");
|
|
while (!input_finish)
|
|
{
|
|
while (1)
|
|
{
|
|
/* read one character from device */
|
|
ch = (int)finsh_getchar();
|
|
if (ch < 0)
|
|
{
|
|
continue;
|
|
}
|
|
if (ch >= ' ' && ch <= '~' && cur_pos < FINSH_PASSWORD_MAX)
|
|
{
|
|
/* change the printable characters to '*' */
|
|
rt_kprintf("*");
|
|
password[cur_pos++] = ch;
|
|
}
|
|
else if (ch == '\b' && cur_pos > 0)
|
|
{
|
|
/* backspace */
|
|
cur_pos--;
|
|
password[cur_pos] = '\0';
|
|
rt_kprintf("\b \b");
|
|
}
|
|
else if (ch == '\r' || ch == '\n')
|
|
{
|
|
rt_kprintf("\n\r");
|
|
input_finish = RT_TRUE;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
if (!rt_strncmp(shell->password, password, FINSH_PASSWORD_MAX)) return;
|
|
else
|
|
{
|
|
/* authentication failed, delay 2S for retry */
|
|
// rt_thread_delay(2 * RT_TICK_PER_SECOND);
|
|
rt_kprintf("Sorry, try again.\n\r");
|
|
cur_pos = 0;
|
|
input_finish = RT_FALSE;
|
|
memset(password, '\0', FINSH_PASSWORD_MAX);
|
|
}
|
|
}
|
|
}
|
|
#endif /* FINSH_USING_AUTH */
|
|
|
|
static void shell_auto_complete(char *prefix)
|
|
{
|
|
rt_kprintf("\n\r");
|
|
msh_auto_complete(prefix);
|
|
rt_kprintf("%s%s", FINSH_PROMPT, prefix);
|
|
}
|
|
|
|
#ifdef FINSH_USING_HISTORY
|
|
static rt_bool_t shell_handle_history(struct finsh_shell *shell)
|
|
{
|
|
#if defined(_WIN32)
|
|
int i;
|
|
rt_kprintf("\r");
|
|
|
|
for (i = 0; i <= 60; i++)
|
|
putchar(' ');
|
|
rt_kprintf("\r");
|
|
|
|
#else
|
|
rt_kprintf("\033[2K\r");
|
|
#endif
|
|
rt_kprintf("%s%s", FINSH_PROMPT, shell->line);
|
|
return RT_FALSE;
|
|
}
|
|
|
|
static void shell_push_history(struct finsh_shell *shell)
|
|
{
|
|
if (shell->line_position != 0)
|
|
{
|
|
/* push history */
|
|
if (shell->history_count >= FINSH_HISTORY_LINES)
|
|
{
|
|
/* if current cmd is same as last cmd, don't push */
|
|
if (memcmp(&shell->cmd_history[FINSH_HISTORY_LINES - 1], shell->line, FINSH_CMD_SIZE))
|
|
{
|
|
/* move history */
|
|
int index;
|
|
for (index = 0; index < FINSH_HISTORY_LINES - 1; index ++)
|
|
{
|
|
memcpy(&shell->cmd_history[index][0],
|
|
&shell->cmd_history[index + 1][0], FINSH_CMD_SIZE);
|
|
}
|
|
memset(&shell->cmd_history[index][0], 0, FINSH_CMD_SIZE);
|
|
memcpy(&shell->cmd_history[index][0], shell->line, shell->line_position);
|
|
|
|
/* it's the maximum history */
|
|
shell->history_count = FINSH_HISTORY_LINES;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* if current cmd is same as last cmd, don't push */
|
|
if (shell->history_count == 0 || memcmp(&shell->cmd_history[shell->history_count - 1], shell->line, FINSH_CMD_SIZE))
|
|
{
|
|
shell->current_history = shell->history_count;
|
|
memset(&shell->cmd_history[shell->history_count][0], 0, FINSH_CMD_SIZE);
|
|
memcpy(&shell->cmd_history[shell->history_count][0], shell->line, shell->line_position);
|
|
|
|
/* increase count and set current history position */
|
|
shell->history_count ++;
|
|
}
|
|
}
|
|
}
|
|
shell->current_history = shell->history_count;
|
|
}
|
|
#endif
|
|
/*
|
|
* handle control key
|
|
* up key : 0x1b 0x5b 0x41
|
|
* down key: 0x1b 0x5b 0x42
|
|
* right key:0x1b 0x5b 0x43
|
|
* left key: 0x1b 0x5b 0x44
|
|
*/
|
|
void finsh_cmd_char(int ch)
|
|
{
|
|
// = finsh_getchar();
|
|
if (ch < 0) return;
|
|
if (ch == 0x1b){
|
|
shell->stat = WAIT_SPEC_KEY;
|
|
return;
|
|
}
|
|
else if (shell->stat == WAIT_SPEC_KEY){
|
|
if (ch == 0x5b){
|
|
shell->stat = WAIT_FUNC_KEY;
|
|
return;
|
|
}
|
|
shell->stat = WAIT_NORMAL;
|
|
}
|
|
else if (shell->stat == WAIT_FUNC_KEY){
|
|
shell->stat = WAIT_NORMAL;
|
|
if (ch == 0x41) /* up key */
|
|
{
|
|
#ifdef FINSH_USING_HISTORY
|
|
/* prev history */
|
|
if (shell->current_history > 0)
|
|
shell->current_history --;
|
|
else{
|
|
shell->current_history = 0;
|
|
return;
|
|
}
|
|
/* copy the history command */
|
|
memcpy(shell->line, &shell->cmd_history[shell->current_history][0],
|
|
FINSH_CMD_SIZE);
|
|
shell->line_curpos = shell->line_position = (rt_uint16_t)strlen(shell->line);
|
|
shell_handle_history(shell);
|
|
#endif
|
|
return;
|
|
}
|
|
else if (ch == 0x42) /* down key */
|
|
{
|
|
#ifdef FINSH_USING_HISTORY
|
|
/* next history */
|
|
if (shell->current_history < shell->history_count - 1)
|
|
shell->current_history ++;
|
|
else
|
|
{
|
|
/* set to the end of history */
|
|
if (shell->history_count != 0)
|
|
shell->current_history = shell->history_count - 1;
|
|
else
|
|
return;
|
|
}
|
|
|
|
memcpy(shell->line, &shell->cmd_history[shell->current_history][0],
|
|
FINSH_CMD_SIZE);
|
|
shell->line_curpos = shell->line_position = (rt_uint16_t)strlen(shell->line);
|
|
shell_handle_history(shell);
|
|
#endif
|
|
return;
|
|
}
|
|
else if (ch == 0x44) /* left key */
|
|
{
|
|
if (shell->line_curpos){
|
|
rt_kprintf("\b");
|
|
shell->line_curpos --;
|
|
}
|
|
return;
|
|
}
|
|
else if (ch == 0x43) /* right key */
|
|
{
|
|
if (shell->line_curpos < shell->line_position){
|
|
rt_kprintf("%c", shell->line[shell->line_curpos]);
|
|
shell->line_curpos ++;
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
/* received null or error */
|
|
if (ch == '\0' || ch == 0xFF) return;
|
|
/* handle tab key */
|
|
else if(ch == '\t'){
|
|
int i;
|
|
/* move the cursor to the beginning of line */
|
|
for (i = 0; i < shell->line_curpos; i++)
|
|
rt_kprintf("\b");
|
|
/* auto complete */
|
|
shell_auto_complete(&shell->line[0]);
|
|
/* re-calculate position */
|
|
shell->line_curpos = shell->line_position = (rt_uint16_t)strlen(shell->line);
|
|
return;
|
|
}
|
|
/* handle backspace key */
|
|
else if (ch == 0x7f || ch == 0x08)
|
|
{
|
|
/* note that shell->line_curpos >= 0 */
|
|
if (shell->line_curpos == 0)
|
|
return;
|
|
shell->line_position--;
|
|
shell->line_curpos--;
|
|
if (shell->line_position > shell->line_curpos)
|
|
{
|
|
int i;
|
|
memmove(&shell->line[shell->line_curpos],
|
|
&shell->line[shell->line_curpos + 1],
|
|
shell->line_position - shell->line_curpos);
|
|
shell->line[shell->line_position] = 0;
|
|
rt_kprintf("\b%s \b", &shell->line[shell->line_curpos]);
|
|
/* move the cursor to the origin position */
|
|
for (i = shell->line_curpos; i <= shell->line_position; i++)
|
|
rt_kprintf("\b");
|
|
}
|
|
else{
|
|
rt_kprintf("\b \b");
|
|
shell->line[shell->line_position] = 0;
|
|
}
|
|
return;
|
|
}
|
|
/* handle end of line, break */
|
|
if (ch == '\r' || ch == '\n')
|
|
{
|
|
#ifdef FINSH_USING_HISTORY
|
|
shell_push_history(shell);
|
|
#endif
|
|
if (shell->echo_mode)
|
|
rt_kprintf("\n\r");
|
|
msh_exec(shell->line, shell->line_position);
|
|
|
|
rt_kprintf(FINSH_PROMPT);
|
|
memset(shell->line, 0, sizeof(shell->line));
|
|
shell->line_curpos = shell->line_position = 0;
|
|
return;
|
|
}
|
|
|
|
/* it's a large line, discard it */
|
|
if (shell->line_position >= FINSH_CMD_SIZE)
|
|
shell->line_position = 0;
|
|
|
|
/* normal character */
|
|
if (shell->line_curpos < shell->line_position)
|
|
{
|
|
int i;
|
|
memmove(&shell->line[shell->line_curpos + 1],
|
|
&shell->line[shell->line_curpos],
|
|
shell->line_position - shell->line_curpos);
|
|
shell->line[shell->line_curpos] = ch;
|
|
if (shell->echo_mode)
|
|
rt_kprintf("%s", &shell->line[shell->line_curpos]);
|
|
|
|
/* move the cursor to new position */
|
|
for (i = shell->line_curpos; i < shell->line_position; i++)
|
|
rt_kprintf("\b");
|
|
}
|
|
else
|
|
{
|
|
shell->line[shell->line_position] = ch;
|
|
if (shell->echo_mode)
|
|
rt_kprintf("%c", ch);
|
|
}
|
|
ch = 0;
|
|
shell->line_position ++;
|
|
shell->line_curpos++;
|
|
if (shell->line_position >= FINSH_CMD_SIZE)
|
|
{
|
|
/* clear command line */
|
|
shell->line_position = 0;
|
|
shell->line_curpos = 0;
|
|
}
|
|
}
|
|
|
|
void finsh_system_function_init(const void *begin, const void *end)
|
|
{
|
|
_syscall_table_begin = (struct finsh_syscall *) begin;
|
|
_syscall_table_end = (struct finsh_syscall *) end;
|
|
}
|
|
|
|
|
|
/*
|
|
* @ingroup finsh
|
|
*
|
|
* This function will initialize finsh shell
|
|
*/
|
|
int finsh_system_init(void)
|
|
{
|
|
rt_err_t result = RT_EOK;
|
|
#ifdef FINSH_USING_SYMTAB
|
|
#ifdef __ARMCC_VERSION /* ARM C Compiler */
|
|
extern const int FSymTab$$Base;
|
|
extern const int FSymTab$$Limit;
|
|
finsh_system_function_init(&FSymTab$$Base, &FSymTab$$Limit);
|
|
#elif defined (__GNUC__) || defined(__TI_COMPILER_VERSION__) || defined(__TASKING__)
|
|
/* GNU GCC Compiler and TI CCS */
|
|
extern const int __fsymtab_start;
|
|
extern const int __fsymtab_end;
|
|
finsh_system_function_init(&__fsymtab_start, &__fsymtab_end);
|
|
#endif
|
|
#endif
|
|
/* create or set shell structure */
|
|
shell = (struct finsh_shell *)calloc(1, sizeof(struct finsh_shell));
|
|
if (shell == RT_NULL)
|
|
{
|
|
rt_kprintf("no memory for shell\n\r");
|
|
return -1;
|
|
}
|
|
finsh_set_prompt_mode(1);
|
|
/* normal is echo mode */
|
|
#ifndef FINSH_ECHO_DISABLE_DEFAULT
|
|
finsh_set_echo(1);
|
|
#else
|
|
finsh_set_echo(0);
|
|
#endif
|
|
#ifdef FINSH_USING_AUTH
|
|
/* set the default password when the password isn't setting */
|
|
if (rt_strlen(finsh_get_password()) == 0){
|
|
if (finsh_set_password(FINSH_DEFAULT_PASSWORD) != RT_EOK){
|
|
rt_kprintf("Finsh password set failed.\n\r");
|
|
}
|
|
}
|
|
/* waiting authenticate success */
|
|
finsh_wait_auth();
|
|
#endif
|
|
return 0;
|
|
}
|
|
INIT_APP_EXPORT(finsh_system_init);
|
|
|
|
#endif /* RT_USING_FINSH */
|
|
|