RT-Thread · mysterywolf · Nov 27, 2024 · Nov 27, 2024
@@ -226,7 +226,7 @@
 Some global variables are stored in the RW segment and the ZI segment. The RW segment holds the global variable with the initial value (the global variable in the constant form is placed in the RO segment, which is a read-only property), and uninitialized global variable is stored in the ZI segment, as in the following example:

 ```c
 #include <rtthread.h>

 const static rt_uint32_t sensor_enable = 0x000000FE;
 rt_uint32_t sensor_value;
@@ -662,14 +662,14 @@
 #define RT_USING_FINSH

 /* While starting the system FinSH: the thread name is defined as tshell */
 #define FINSH_THREAD_NAME "tshell"

 /* While turning the system FinSH: use history commands. */
 #define FINSH_USING_HISTORY
 /* While turning the system FinSH: define the number of historical command lines. */
 #define FINSH_HISTORY_LINES 5
 
-/* While turning the system FinSH: define this macro to open the Tab key, if not defined, close. */
+/* While turning the system FinSH: define this macro to use symbol table in Finsh, if not defined, close. */
 #define FINSH_USING_SYMTAB
 
 /* While turning the system FinSH: define the priority of the thread. */
@@ -684,7 +684,7 @@
 /* While turning the system FinSH：when MSH function is enabled, macro is defined to use the MSH function by default. */
 #define FINSH_USING_MSH_DEFAULT
 /* While turning the system FinSH：define this macro to use only the MSH function. */
 #define FINSH_USING_MSH_ONLY
 ```

 （7）About MCU

@@ -10,7 +10,7 @@

 FinSH is the command line component of RT-Thread. It provides a set of operation interfaces for users to call from the command line. It is mainly used to debug or view system information. It can communicate with a PC using serial/Ethernet/USB, etc. The hardware topology is shown below:

 ![FinSH Hardware connection diagram](figures/finsh-hd.png)

 The user inputs a command in the control terminal, and the control terminal transmits the command to the FinSH in the device through the serial port, USB, network, etc., FinSH will read the device input command, parse and automatically scan the internal function table, find the corresponding function name, and execute the function. The response is output, the response is returned through the original path, and the result is displayed on the control terminal.

@@ -33,7 +33,7 @@

 ### Traditional Command Line Mode

 This mode is also known as msh(module shell). In msh mode, FinSH is implemented in the same way as the traditional shell (dos/bash). For example, you can switch directories to the root directory with the `cd /` command.

 MSH can parse commands into parameters and parameters separated by spaces. Its command execution format is as follows:

@@ -67,7 +67,7 @@
 list_event      - list event in system
 list_mutex      - list mutex in system
 list_mailbox    - list mail box in system
 list_msgqueue   - list message queue in system
 list_timer      - list timer in system
 list_device     - list device in system
 exit            - return to RT-Thread shell mode.
@@ -87,8 +87,8 @@
 msh />list_thread
 thread   pri  status      sp     stack size max used left tick  error
 -------- ---  ------- ---------- ----------  ------  ---------- ---
 tshell    20  ready   0x00000118 0x00001000    29%   0x00000009 000
 tidle     31  ready   0x0000005c 0x00000200    28%   0x00000005 000
 timer      4  suspend 0x00000078 0x00000400    11%   0x00000009 000
 ```
 list_thread Return field description:
@@ -112,7 +112,7 @@
 msh />list_sem
 semaphore v   suspend thread
 -------- --- --------------
 shrx     000 0
 e0       000 0
 ```

@@ -158,7 +158,7 @@

 | **Field**      | **Description**                                        |
 |----------------|------------------------------------|
 | mutxe          | Mutex name                                             |
 | owner          | The thread currently holding the mutex                 |
 | hold           | The number of times the holder is nested on this mutex |
 | suspend thread | The number of threads waiting for this mutex |
@@ -171,8 +171,8 @@
 msh />list_mailbox
 mailbox  entry size suspend thread
 -------- ----  ---- --------------
 etxmb    0000  0008 1:etx
 erxmb    0000  0008 1:erx
 ```

 list_mailbox Return field description:
@@ -198,7 +198,7 @@

 | Field          | **Description**                                              |
 |----------------|----------------------------|
 | msgqueue       | Message queue name                                           |
 | entry          | The number of messages currently included in the message queue |
 | suspend thread | Number of threads waiting for this message queue |

@@ -421,7 +421,7 @@
 /* Record 5 lines of history commands */
 #define FINSH_HISTORY_LINES 5
 
-/* Enable the use of the Tab key */
+/* Enable the use of symbol table */
 #define FINSH_USING_SYMTAB
 /* Turn on description */
 #define FINSH_USING_DESCRIPTION
@@ -540,9 +540,9 @@
 Run the `atcmd client` command and the result is as follows:

 ```c
 msh />atcmd client
 AT client!
 msh />
 ```

 ## FinSH Porting
@@ -551,7 +551,7 @@

 * FinSH thread：

 Each command execution is done in the context of a FinSH thread (that is, a tshell thread). When the RT_USING_FINSH macro is defined, the FinSH thread can be initialized by calling `finsh_system_init()` in the initialization thread. In RT-Thread 1.2.0 and later, you don't have to use the `finsh_set_device(const char* device_name)` function to explicitly specify the device to be used. Instead, the `rt_console_get_device()` function is called automatically to use the console device (The `finsh_set_device(const char* device_name)` must be used in 1.1.x and below to specify the device used by FinSH. The FinSH thread is created in the function `finsh_system_init()` function, which will wait for the rx_sem semaphore.

 * FinSH output：