finsh shell

宏定义
#define	FINSH_FUNCTION_EXPORT(name, desc)
#define	FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
#define	MSH_CMD_EXPORT(...)
#define	MSH_CMD_EXPORT_ALIAS(...)

函数
rt_uint32_t	finsh_get_prompt_mode (void)
void	finsh_set_prompt_mode (rt_uint32_t prompt_mode)
void	finsh_set_device (const char *device_name)
const char *	finsh_get_device ()
void	finsh_set_echo (rt_uint32_t echo)
rt_uint32_t	finsh_get_echo ()
void	finsh_thread_entry_sethook (void(*hook)(void))

详细描述

finsh shell is a user command shell in RT-Thread RTOS.

finsh shell is a user command shell in RT-Thread RTOS, which is a shell can accept C-expression like syntax in command. From finsh shell, user can access system area, such as memory, variables and function by input C-expression in command.

Figure 3: finsh shell architecture

There is a shell thread, which named as "tshell", in the finsh shell, it read user command from console device, and then invokes system function or access system variable to output result (by rt_kprintf).

宏定义说明

FINSH_FUNCTION_EXPORT

#define FINSH_FUNCTION_EXPORT	(		name,
			desc )

This macro exports a system function to finsh shell.

参数

name	the name of function.
desc	the description of function, which will show in help.

在文件 components/finsh/finsh.h 第 119 行定义.

FINSH_FUNCTION_EXPORT_ALIAS

#define FINSH_FUNCTION_EXPORT_ALIAS	(		name,
			alias,
			desc )

This macro exports a system function with an alias name to finsh shell.

参数

name	the name of function.
alias	the alias name of function.
desc	the description of function, which will show in help.

在文件 components/finsh/finsh.h 第 130 行定义.

MSH_CMD_EXPORT

#define MSH_CMD_EXPORT

(

...

)

值:

    __MSH_GET_MACRO(__VA_ARGS__, _MSH_FUNCTION_CMD2_OPT,    \
        _MSH_FUNCTION_CMD2)(__VA_ARGS__)

This macro exports a command to module shell.

param command is the name of the command. param desc is the description of the command, which will show in help list. param opt This is an option, enter any content to enable option completion

在文件 components/finsh/finsh.h 第 142 行定义.

#define MSH_CMD_EXPORT(...)                                 \
    __MSH_GET_MACRO(__VA_ARGS__, _MSH_FUNCTION_CMD2_OPT,    \
        _MSH_FUNCTION_CMD2)(__VA_ARGS__)

MSH_CMD_EXPORT_ALIAS

#define MSH_CMD_EXPORT_ALIAS

(

...

)

值:

    __MSH_GET_EXPORT_MACRO(__VA_ARGS__, _MSH_FUNCTION_EXPORT_CMD3_OPT,      \
            _MSH_FUNCTION_EXPORT_CMD3)(__VA_ARGS__)

This macro exports a command with alias to module shell.

param command is the name of the command. param alias is the alias of the command. param desc is the description of the command, which will show in help list. param opt This is an option, enter any content to enable option completion

#define MSH_CMD_EXPORT_ALIAS(command, alias, desc) or
#define MSH_CMD_EXPORT_ALIAS(command, alias, desc, opt)

在文件 components/finsh/finsh.h 第 160 行定义.

#define MSH_CMD_EXPORT_ALIAS(...)                                           \
    __MSH_GET_EXPORT_MACRO(__VA_ARGS__, _MSH_FUNCTION_EXPORT_CMD3_OPT,      \
            _MSH_FUNCTION_EXPORT_CMD3)(__VA_ARGS__)

函数说明

finsh_get_prompt_mode()

rt_uint32_t finsh_get_prompt_mode

(

void

)

This function get the prompt mode of finsh shell.

返回

prompt the prompt mode, 0 disable prompt mode, other values enable prompt mode.

在文件 shell.c 第 136 行定义.

{
    RT_ASSERT(shell != RT_NULL);
    return shell->prompt_mode;
}

引用了 RT_ASSERT, RT_NULL , 以及 shell.

finsh_set_prompt_mode()

void finsh_set_prompt_mode

(

rt_uint32_t

prompt_mode

)

This function set the prompt mode of finsh shell.

The parameter 0 disable prompt mode, other values enable prompt mode.

参数

prompt_mode

the prompt mode

在文件 shell.c 第 151 行定义.

{
    RT_ASSERT(shell != RT_NULL);
    shell->prompt_mode = prompt_mode;
}

引用了 RT_ASSERT, RT_NULL , 以及 shell.

这是这个函数的调用关系图:

finsh_set_device()

void finsh_set_device

(

const char *

device_name

)

This function sets the input device of finsh shell.

参数

device_name

the name of new input device.

在文件 shell.c 第 219 行定义.

{
    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 */
        rt_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);
    }
}

引用了 RT_ASSERT, rt_device_close(), rt_device_find(), RT_DEVICE_FLAG_INT_RX, RT_DEVICE_FLAG_STREAM, RT_DEVICE_OFLAG_RDWR, rt_device_open(), rt_device_set_rx_indicate(), rt_kprintf, RT_NULL , 以及 shell.

函数调用图:

finsh_get_device()

const char * finsh_get_device

(

void

)

This function returns current finsh shell input device.

返回

the finsh shell input device name is returned.

在文件 shell.c 第 260 行定义.

{
    RT_ASSERT(shell != RT_NULL);
    return shell->device->parent.name;
}

引用了 RT_ASSERT, RT_NULL , 以及 shell.

finsh_set_echo()

void finsh_set_echo

(

rt_uint32_t

echo

)

This function set the echo mode of finsh shell.

FINSH_OPTION_ECHO=0x01 is echo mode, other values are none-echo mode.

参数

echo	the echo mode

在文件 shell.c 第 276 行定义.

{
    RT_ASSERT(shell != RT_NULL);
    shell->echo_mode = (rt_uint8_t)echo;
}

引用了 RT_ASSERT, RT_NULL , 以及 shell.

finsh_get_echo()

rt_uint32_t finsh_get_echo

(

void

)

This function gets the echo mode of finsh shell.

返回

the echo mode

在文件 shell.c 第 289 行定义.

{
    RT_ASSERT(shell != RT_NULL);
 
    return shell->echo_mode;
}

引用了 RT_ASSERT, RT_NULL , 以及 shell.

finsh_thread_entry_sethook()

void finsh_thread_entry_sethook

(

void(*

hook )(void)

)

This function set a hook function at the entry of finsh thread

参数

hook	the function point to be called

在文件 shell.c 第 470 行定义.

{
    _finsh_thread_entry_hook = hook;
}