mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-23 20:09:05 +08:00
c40b79037c
* doxygen: add prefix for groups
Add "group_" prefix to doxygen group names. This makes
it easier to grep with group name later.
This patch only modifies the groups defined in the pathes
of INPUT of documentation/Doxyfile:
INPUT = . \
../src \
../include \
../components/finsh \
../components/drivers/include/drivers \
../components/drivers/clk \
../components/dfs/dfs_v2/src \
../components/dfs/dfs_v2/include
Other groups are not touched.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
* ci: fixed error report when run file_check.py
Such as:
- "please delete extra space at the end of this line."
- "the RT-Thread error code should return negative value. e.g. return
-RT_ERROR"
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
---------
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
64 lines
1.5 KiB
C
64 lines
1.5 KiB
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_SystemInit System Initialization
|
|
*
|
|
* @brief System initialization procedure.
|
|
*
|
|
* When RT-Thread operating system starts up, the basic operating system facility
|
|
* initialization routines must be invoked.
|
|
*
|
|
* The suggested initialization sequence is:
|
|
*
|
|
* - initialize device hardware
|
|
* rt_hw_board_init();
|
|
*
|
|
* User can put the low level hardware initialization in this function, such as
|
|
* DDR memory setting, pinmux setting, console device setting etc.
|
|
*
|
|
* - show version
|
|
* rt_show_version();
|
|
*
|
|
* - initialize timer system
|
|
* rt_system_timer_init();
|
|
*
|
|
* - initialize system heap memory
|
|
* rt_system_heap_init(__bss_end, __end_of_memory);
|
|
*
|
|
* - initialize module system
|
|
* rt_system_module_init();
|
|
*
|
|
* - initialize scheduler system
|
|
* rt_system_scheduler_init();
|
|
*
|
|
* - initialize application
|
|
* rt_application_init();
|
|
*
|
|
* - initialize system timer thread
|
|
* rt_system_timer_thread_init();
|
|
*
|
|
* - initialize idle thread
|
|
* rt_thread_idle_init();
|
|
*
|
|
* - start scheduler
|
|
* rt_system_scheduler_start();
|
|
*/
|
|
|
|
/**
|
|
* @ingroup group_SystemInit
|
|
*
|
|
* This function will initialize user application.
|
|
*
|
|
* This function will be invoked when system initialization and system scheduler
|
|
* has not started. User can allocate memory, create thread, semaphore etc. However,
|
|
* user shall not suspend 'current' thread.
|
|
*/
|
|
void rt_application_init();
|
|
|
|
/**
|
|
* @ingroup group_SystemInit
|
|
*/
|
|
void rt_system_heap_init(void* begin_addr, void* end_addr);
|