2c98ce4605
将Doxygen输入文件（由Doxyfile中的INPUT定义）中的失效Doxygen分组指令（如/*@*/和/*@}*/）更改为有效的分组指令（如/**@*/和/**@}*/）；（此处只对INPUT中的文件做了修改，bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令，但由于不作为文档的输入文件且这些文件过于庞大老旧，没有对这些文件中的无效指令做修改） 将图片文件统一放入了images目录下； 修改了Doxyfile和部分Doxygen注释，使得Doxyfile能够定位到新的代码路径且不受重复实现的影响； 解决了一些注释中的参数名不匹配、参数多余/缺失等问题。
88 lines
2.3 KiB
C
88 lines
2.3 KiB
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup bsp Hardware Related Package
|
|
*
|
|
* @brief Hardware Related Package includes board support package(BSP) and CSP(Chip
|
|
* Support Package).
|
|
*
|
|
* Board Support Package(BSP) is the hardware related wrapper, for example, peripherals
|
|
* in board, the pinmux setting etc. In RT-Thread RTOS, the bsp is placed under bsp
|
|
* directory.
|
|
*
|
|
* Chip Support Package(CSP) is a software set that contains chip specific software.
|
|
* A CSP usually includes operating system porting and peripheral device drivers inside
|
|
* chip. In RT-Thread RTOS, the csp is placed under libcpu directory.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup bsp
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* This function will return current system interrupt status and disable system
|
|
* interrupt.
|
|
*
|
|
* @return the current system interrupt status.
|
|
*/
|
|
rt_base_t rt_hw_interrupt_disable(void);
|
|
|
|
/**
|
|
* This function will set the specified interrupt status, which shall saved by
|
|
* rt_hw_intterrupt_disable function. If the saved interrupt status is interrupt
|
|
* opened, this function will open system interrupt status.
|
|
*
|
|
* @param level the interrupt status to be set.
|
|
*/
|
|
void rt_hw_interrupt_enable(rt_base_t level);
|
|
|
|
/**
|
|
* This function initializes interrupt.
|
|
*/
|
|
void rt_hw_interrupt_init(void);
|
|
|
|
/**
|
|
* This function masks the specified interrupt.
|
|
*
|
|
* @param vector the interrupt number to be masked.
|
|
*
|
|
* @note not all of platform provide this function.
|
|
*/
|
|
void rt_hw_interrupt_mask(int vector);
|
|
|
|
/**
|
|
* This function umasks the specified interrupt.
|
|
*
|
|
* @param vector the interrupt number to be unmasked.
|
|
*
|
|
* @note not all of platform provide this function.
|
|
*/
|
|
void rt_hw_interrupt_umask(int vector);
|
|
|
|
/**
|
|
* This function will install specified interrupt handler.
|
|
*
|
|
* @param vector the interrupt number to be installed.
|
|
* @param new_handler the new interrupt handler.
|
|
* @param old_handler the old interrupt handler. This parameter can be RT_NULL.
|
|
*
|
|
* @note not all of platform provide this function.
|
|
*/
|
|
void rt_hw_interrupt_install(int vector, rt_isr_handler_t new_handler,
|
|
rt_isr_handler_t *old_handler);
|
|
|
|
/**
|
|
* This function will reset whole platform.
|
|
*/
|
|
void rt_hw_cpu_reset(void);
|
|
|
|
/**
|
|
* This function will halt whole platform.
|
|
*/
|
|
void rt_hw_cpu_shutdown(void);
|
|
|
|
/**@}*/
|