1 /*
2  * This file is only used for doxygen document generation.
3  *
4  * Components
5  * - Device Virtual File System
6  * - Device Driver
7  * - Finsh Shell
8  * - Application Module
9   */
10 
11 /**
12  * @defgroup group_kernel_components Components
13  *
14  * Components of RT-Thread, see @ref page_components for more details.
15  */
16 
17 /**
18  * @addtogroup group_kernel_components
19  * @{
20  */
21 
22 /**
23  * @defgroup group_device_virtual_file_system Device Virtual File System
24  *
25  * @brief DFS is a virtual file system in RT-Thread RTOS.
26  *
27  * The DFS (Device Virtual File System) is a vfs file system of RT-Thread RTOS,
28  * which is focused on embedded device. VFS is an abstraction layer on top of a
29  * more concrete file system. The purpose of a VFS is to allow client applications
30  * to access different types of concrete file systems in a uniform way.
31  *
32  * @image html dfs.png "Figure 4: Device Virtual File System Architecture"
33  *
34  * The DFS specifies an interface between the kernel and a concrete file system.
35  * Therefore, it is easy to add support for new file system types to the kernel
36  * simply by fulfilling the interface.
37  */
38 
39 /**
40  * @defgroup group_device_driver Device Driver
41  * @brief device I/O subsystem
42  *
43  * The Device System is designed as simple and minimum layer to help communication between
44  * applications and drivers.
45  *
46  * The Device System provide five interfaces to driver:
47  * - open, open a device
48  * - close, close a device
49  * - read, read some data from a device
50  * - write, write some data to a device
51  * - control, send some control command to a device
52  */
53 
54 /**
55  * @defgroup group_finsh Finsh Shell
56  *
57  * @brief finsh shell is a user command shell in RT-Thread RTOS.
58  *
59  * finsh shell is a user command shell in RT-Thread RTOS, which is a shell can
60  * accept C-expression like syntax in command. From finsh shell, user can access
61  * system area, such as memory, variables and function by input C-expression in
62  * command.
63  *
64  * @image html finsh.png "Figure 3: finsh shell architecture"
65  * There is a shell thread, which named as "tshell", in the finsh shell, it read
66  * user command from console device, and then invokes system function or access
67  * system variable to output result (by rt_kprintf).
68  */
69 
70 /**
71  * @defgroup group_module Application Module
72  *
73  * @brief Application Module is a feature let user to execute application in RT-Thread RTOS.
74  *
75  * Application Module is implemented as dynamic object loader, but it can handle
76  * the dependences relationship between application and dynamic library, moreover,
77  * it also can handle the kernel object destroy and memory release issue when application
78  * (abnormally) exit.
79  */
80 
81 /**@}*/