diff --git a/ports/ARM7/chcore.c b/ports/ARM7/chcore.c index 9ffe94ac5..fd7661373 100644 --- a/ports/ARM7/chcore.c +++ b/ports/ARM7/chcore.c @@ -18,6 +18,8 @@ */ /** + * @file ports/ARM7/chcore.c + * @brief ARM7 architecture port code. * @addtogroup ARM7_CORE * @{ */ diff --git a/ports/ARM7/chcore.h b/ports/ARM7/chcore.h index 41efb7f7e..9f75df2cb 100644 --- a/ports/ARM7/chcore.h +++ b/ports/ARM7/chcore.h @@ -18,6 +18,8 @@ */ /** + * @file ports/ARM7/chcore.h + * @brief ARM7 architecture port macros and structures. * @addtogroup ARM7_CORE * @{ */ diff --git a/ports/ARM7/chcoreasm.s b/ports/ARM7/chcoreasm.s index e8fd2881d..9c24de407 100644 --- a/ports/ARM7/chcoreasm.s +++ b/ports/ARM7/chcoreasm.s @@ -17,8 +17,11 @@ along with this program. If not, see . */ -/* - * ARM7 port system code. +/** + * @file ports/ARM7/chcoreasm.s + * @brief ARM7 architecture port low level code. + * @addtogroup ARM7_CORE + * @{ */ #include @@ -225,3 +228,5 @@ _port_thread_start: jmpr4: bx r4 #endif /* !THUMB_NO_INTERWORKING */ + +/** @} */ diff --git a/ports/ARM7/chtypes.h b/ports/ARM7/chtypes.h index faf0ee0fc..570c719da 100644 --- a/ports/ARM7/chtypes.h +++ b/ports/ARM7/chtypes.h @@ -18,6 +18,8 @@ */ /** + * @file ports/ARM7/chtypes.h + * @brief ARM7 architecture port system types. * @addtogroup ARM7_CORE * @{ */ diff --git a/ports/ARM7/crt0.s b/ports/ARM7/crt0.s index c5a341793..b910293b9 100644 --- a/ports/ARM7/crt0.s +++ b/ports/ARM7/crt0.s @@ -17,8 +17,11 @@ along with this program. If not, see . */ -/* - * Generic ARM7 startup file for ChibiOS/RT. +/** + * @file ports/ARM7/crt0.s + * @brief Generic ARM7 startup file for ChibiOS/RT. + * @addtogroup ARM7_CORE + * @{ */ .set MODE_USR, 0x10 @@ -189,3 +192,5 @@ hwinit0: .thumb_func hwinit1: bx lr + +/** @} */ diff --git a/ports/ARMCM3/chcore.c b/ports/ARMCM3/chcore.c index 8edbb658a..5f4b87dee 100644 --- a/ports/ARMCM3/chcore.c +++ b/ports/ARMCM3/chcore.c @@ -18,6 +18,8 @@ */ /** + * @file ports/ARMCM3/chcore.c + * @brief ARM Cortex-M3 architecture port code. * @addtogroup ARMCM3_CORE * @{ */ diff --git a/ports/ARMCM3/chcore.h b/ports/ARMCM3/chcore.h index 638995f1c..b45da04bb 100644 --- a/ports/ARMCM3/chcore.h +++ b/ports/ARMCM3/chcore.h @@ -18,6 +18,8 @@ */ /** + * @file ports/ARMCM3/chcore.h + * @brief ARM Cortex-M3 architecture port macros and structures. * @addtogroup ARMCM3_CORE * @{ */ diff --git a/ports/ARMCM3/chtypes.h b/ports/ARMCM3/chtypes.h index 4f00eb65f..7373b9823 100644 --- a/ports/ARMCM3/chtypes.h +++ b/ports/ARMCM3/chtypes.h @@ -17,6 +17,13 @@ along with this program. If not, see . */ +/** + * @file ports/ARMCM3/chtypes.h + * @brief ARM Cortex-M3 architecture port system types. + * @addtogroup ARMCM3_CORE + * @{ + */ + #ifndef _CHTYPES_H_ #define _CHTYPES_H_ @@ -29,15 +36,15 @@ #include #endif -typedef int32_t bool_t; -typedef uint8_t tmode_t; -typedef uint8_t tstate_t; -typedef uint32_t tprio_t; -typedef int32_t msg_t; -typedef int32_t eventid_t; -typedef uint32_t eventmask_t; -typedef uint32_t systime_t; -typedef int32_t cnt_t; +typedef int32_t bool_t; /**< Fast boolean type. */ +typedef uint8_t tmode_t; /**< Thread flags. */ +typedef uint8_t tstate_t; /**< Thread state. */ +typedef uint32_t tprio_t; /**< Thread priority. */ +typedef int32_t msg_t; /**< Inter-thread message. */ +typedef int32_t eventid_t; /**< Event Id. */ +typedef uint32_t eventmask_t; /**< Events mask. */ +typedef uint32_t systime_t; /**< System time. */ +typedef int32_t cnt_t; /**< Resources counter. */ #define INLINE inline #define PACK_STRUCT_STRUCT __attribute__((packed)) @@ -45,3 +52,5 @@ typedef int32_t cnt_t; #define PACK_STRUCT_END #endif /* _CHTYPES_H_ */ + +/** @} */ diff --git a/ports/ARMCM3/crt0.s b/ports/ARMCM3/crt0.s index d31b36475..72b104a0c 100644 --- a/ports/ARMCM3/crt0.s +++ b/ports/ARMCM3/crt0.s @@ -17,8 +17,11 @@ along with this program. If not, see . */ -/* - * Generic ARM-CortexM3 startup file for ChibiOS/RT. +/** + * @file ports/ARMCM3/crt0.s + * @brief Generic ARM Xortex-M3 startup file for ChibiOS/RT. + * @addtogroup ARMCM3_CORE + * @{ */ .set CONTROL_MODE_PRIVILEGED, 0 @@ -111,3 +114,5 @@ hwinit0: .weak hwinit1 hwinit1: bx lr + +/** @} */ diff --git a/ports/AVR/chcore.c b/ports/AVR/chcore.c index ee35f3459..41888ca3f 100644 --- a/ports/AVR/chcore.c +++ b/ports/AVR/chcore.c @@ -18,6 +18,8 @@ */ /** + * @file ports/AVR/chcore.c + * @brief AVR architecture port code. * @addtogroup AVR_CORE * @{ */ diff --git a/ports/AVR/chcore.h b/ports/AVR/chcore.h index ab2d2f6d5..44f7b3506 100644 --- a/ports/AVR/chcore.h +++ b/ports/AVR/chcore.h @@ -18,6 +18,8 @@ */ /** + * @file ports/AVR/chcore.h + * @brief AVR architecture port macros and structures. * @addtogroup AVR_CORE * @{ */ diff --git a/ports/AVR/chtypes.h b/ports/AVR/chtypes.h index 91e8ee055..e5920746c 100644 --- a/ports/AVR/chtypes.h +++ b/ports/AVR/chtypes.h @@ -17,6 +17,13 @@ along with this program. If not, see . */ +/** + * @file ports/AVR/chtypes.h + * @brief AVR architecture port system types. + * @addtogroup AVR_CORE + * @{ + */ + #ifndef _CHTYPES_H_ #define _CHTYPES_H_ @@ -29,15 +36,15 @@ #include #endif -typedef int8_t bool_t; -typedef uint8_t tmode_t; -typedef uint8_t tstate_t; -typedef uint8_t tprio_t; -typedef int16_t msg_t; -typedef uint8_t eventid_t; -typedef uint8_t eventmask_t; -typedef uint16_t systime_t; -typedef int8_t cnt_t; +typedef int8_t bool_t; /**< Fast boolean type. */ +typedef uint8_t tmode_t; /**< Thread flags. */ +typedef uint8_t tstate_t; /**< Thread state. */ +typedef uint8_t tprio_t; /**< Thread priority. */ +typedef int16_t msg_t; /**< Inter-thread message. */ +typedef uint8_t eventid_t; /**< Event Id. */ +typedef uint8_t eventmask_t; /**< Events mask. */ +typedef uint16_t systime_t; /**< System time. */ +typedef int8_t cnt_t; /**< Resources counter. */ #define INLINE inline #define PACK_STRUCT_STRUCT __attribute__((packed)) @@ -45,3 +52,5 @@ typedef int8_t cnt_t; #define PACK_STRUCT_END #endif /* _CHTYPES_H_ */ + +/** @} */ diff --git a/ports/MSP430/chcore.c b/ports/MSP430/chcore.c index 2f147c2fc..4a9857494 100644 --- a/ports/MSP430/chcore.c +++ b/ports/MSP430/chcore.c @@ -18,6 +18,8 @@ */ /** + * @file ports/MSP430/chcore.c + * @brief MSP430 architecture port code. * @addtogroup MSP430_CORE * @{ */ diff --git a/ports/MSP430/chcore.h b/ports/MSP430/chcore.h index 9c42487f2..dd0fbc3fb 100644 --- a/ports/MSP430/chcore.h +++ b/ports/MSP430/chcore.h @@ -18,6 +18,8 @@ */ /** + * @file ports/MSP430/chcore.h + * @brief MSP430 architecture port macros and structures. * @addtogroup MSP430_CORE * @{ */ diff --git a/ports/MSP430/chtypes.h b/ports/MSP430/chtypes.h index 218617cfe..f8d7c944a 100644 --- a/ports/MSP430/chtypes.h +++ b/ports/MSP430/chtypes.h @@ -18,7 +18,9 @@ */ /** - * @addtogroup Core + * @file ports/MSP430/chtypes.h + * @brief MSP430 architecture port system types. + * @addtogroup MSP430_CORE * @{ */ @@ -34,15 +36,15 @@ #include #endif -typedef int16_t bool_t; /* Signed boolean. */ -typedef uint8_t tmode_t; /* Thread mode flags, uint8_t is ok. */ -typedef uint8_t tstate_t; /* Thread state, uint8_t is ok. */ -typedef uint16_t tprio_t; /* Priority, use the fastest unsigned type. */ -typedef int16_t msg_t; /* Message, use signed pointer equivalent.*/ -typedef int16_t eventid_t; /* Event Id, use fastest signed.*/ -typedef uint16_t eventmask_t;/* Event Mask, recommended fastest unsigned.*/ -typedef uint16_t systime_t; /* System Time, recommended fastest unsigned.*/ -typedef int16_t cnt_t; /* Counter, recommended fastest signed.*/ +typedef int16_t bool_t; /**< Fast boolean type. */ +typedef uint8_t tmode_t; /**< Thread flags. */ +typedef uint8_t tstate_t; /**< Thread state. */ +typedef uint16_t tprio_t; /**< Thread priority. */ +typedef int16_t msg_t; /**< Inter-thread message. */ +typedef int16_t eventid_t; /**< Event Id. */ +typedef uint16_t eventmask_t; /**< Events mask. */ +typedef uint16_t systime_t; /**< System time. */ +typedef int16_t cnt_t; /**< Resources counter. */ #define INLINE inline #define PACK_STRUCT_STRUCT __attribute__((packed))