mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-24 15:27:04 +08:00
40f3b6a569
* doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>
64 lines
1.5 KiB
C
64 lines
1.5 KiB
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup 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 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 SystemInit
|
|
*/
|
|
void rt_system_heap_init(void* begin_addr, void* end_addr);
|