mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-16 23:40:13 +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>
78 lines
2.1 KiB
C
78 lines
2.1 KiB
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_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 group_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);
|
|
|
|
/**@}*/
|