diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-08-23 10:09:08 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-08-23 10:09:08 +0000 |
| commit | c9be79def630f153b0b2d28e905939c15743f989 (patch) | |
| tree | d88d60cde858f1efff1bdd5fb1f201ba69f286cc /os/kernel/include/chsys.h | |
| parent | 2d55ac3059fcca69cc9736db310b4521064c2b23 (diff) | |
| download | ChibiOS-c9be79def630f153b0b2d28e905939c15743f989.tar.gz ChibiOS-c9be79def630f153b0b2d28e905939c15743f989.tar.bz2 ChibiOS-c9be79def630f153b0b2d28e905939c15743f989.zip | |
Kernel documentation fixes and improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3251 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/include/chsys.h')
| -rw-r--r-- | os/kernel/include/chsys.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/os/kernel/include/chsys.h b/os/kernel/include/chsys.h index f807182ac..b69736a1d 100644 --- a/os/kernel/include/chsys.h +++ b/os/kernel/include/chsys.h @@ -29,6 +29,10 @@ #ifndef _CHSYS_H_
#define _CHSYS_H_
+/**
+ * @name Macro Functions
+ * @{
+ */
#if !CH_NO_IDLE_THREAD || defined(__DOXYGEN__)
/**
* @brief Returns a pointer to the idle thread.
@@ -177,8 +181,12 @@ dbg_check_unlock_from_isr(); \
port_unlock_from_isr(); \
}
+/** @} */
/**
+ * @name ISRs abstraction macros
+ */
+/**
* @brief IRQ handler enter code.
* @note Usually IRQ handlers functions are also declared naked.
* @note On some architectures this macro can be empty.
@@ -211,8 +219,12 @@ * @special
*/
#define CH_IRQ_HANDLER(id) PORT_IRQ_HANDLER(id)
+/** @} */
/**
+ * @name Fast ISRs abstraction macros
+ */
+/**
* @brief Standard fast IRQ handler declaration.
* @note @p id can be a function name or a vector number depending on the
* port implementation.
@@ -221,6 +233,7 @@ * @special
*/
#define CH_FAST_IRQ_HANDLER(id) PORT_FAST_IRQ_HANDLER(id)
+/** @} */
#ifdef __cplusplus
extern "C" {
|