diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/inline/rtems/score/watchdog.inl | 121 |
1 files changed, 28 insertions, 93 deletions
diff --git a/cpukit/score/inline/rtems/score/watchdog.inl b/cpukit/score/inline/rtems/score/watchdog.inl index aace2123a6..4aebc4b34b 100644 --- a/cpukit/score/inline/rtems/score/watchdog.inl +++ b/cpukit/score/inline/rtems/score/watchdog.inl @@ -1,9 +1,12 @@ -/* watchdog.inl +/** + * @file watchdog.inl * * This file contains the static inline implementation of all inlined * routines in the Watchdog Handler. - * - * COPYRIGHT (c) 1989-1999. + */ + +/* + * COPYRIGHT (c) 1989-2004. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -16,12 +19,12 @@ #ifndef __WATCHDOG_inl #define __WATCHDOG_inl -/*PAGE - * - * _Watchdog_Initialize - * - * DESCRIPTION: - * +/** + * @addtogroup ScoreWatchdog + * @{ + */ + +/** * This routine initializes the specified watchdog. The watchdog is * made inactive, the watchdog id and handler routine are set to the * specified values. @@ -40,12 +43,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Initialize( the_watchdog->user_data = user_data; } -/*PAGE - * - * _Watchdog_Is_active - * - * DESCRIPTION: - * +/** * This routine returns TRUE if the watchdog timer is in the ACTIVE * state, and FALSE otherwise. */ @@ -59,12 +57,7 @@ RTEMS_INLINE_ROUTINE boolean _Watchdog_Is_active( } -/*PAGE - * - * _Watchdog_Activate - * - * DESCRIPTION: - * +/** * This routine activates THE_WATCHDOG timer which is already * on a watchdog chain. */ @@ -78,12 +71,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Activate( } -/*PAGE - * - * _Watchdog_Deactivate - * - * DESCRIPTION: - * +/** * This routine deactivates THE_WATCHDOG timer which will remain * on a watchdog chain. */ @@ -97,12 +85,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Deactivate( } -/*PAGE - * - * _Watchdog_Tickle_ticks - * - * DESCRIPTION: - * +/** * This routine is invoked at each clock tick to update the ticks * watchdog chain. */ @@ -114,12 +97,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Tickle_ticks( void ) } -/*PAGE - * - * _Watchdog_Tickle_seconds - * - * DESCRIPTION: - * +/** * This routine is invoked at each clock tick to update the seconds * watchdog chain. */ @@ -131,12 +109,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Tickle_seconds( void ) } -/*PAGE - * - * _Watchdog_Insert_ticks - * - * DESCRIPTION: - * +/** * This routine inserts THE_WATCHDOG into the ticks watchdog chain * for a time of UNITS ticks. The INSERT_MODE indicates whether * THE_WATCHDOG is to be activated automatically or later, explicitly @@ -155,12 +128,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Insert_ticks( } -/*PAGE - * - * _Watchdog_Insert_seconds - * - * DESCRIPTION: - * +/** * This routine inserts THE_WATCHDOG into the seconds watchdog chain * for a time of UNITS seconds. The INSERT_MODE indicates whether * THE_WATCHDOG is to be activated automatically or later, explicitly @@ -179,12 +147,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Insert_seconds( } -/*PAGE - * - * _Watchdog_Adjust_seconds - * - * DESCRIPTION: - * +/** * This routine adjusts the seconds watchdog chain in the forward * or backward DIRECTION for UNITS seconds. This is invoked when the * current time of day is changed. @@ -200,12 +163,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Adjust_seconds( } -/*PAGE - * - * _Watchdog_Adjust_ticks - * - * DESCRIPTION: - * +/** * This routine adjusts the ticks watchdog chain in the forward * or backward DIRECTION for UNITS ticks. */ @@ -220,12 +178,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Adjust_ticks( } -/*PAGE - * - * _Watchdog_Reset - * - * DESCRIPTION: - * +/** * This routine resets THE_WATCHDOG timer to its state at INSERT * time. This routine is valid only on interval watchdog timers * and is used to make an interval watchdog timer fire "every" so @@ -243,12 +196,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Reset( } -/*PAGE - * - * _Watchdog_Next - * - * DESCRIPTION: - * +/** * This routine returns a pointer to the watchdog timer following * THE_WATCHDOG on the watchdog chain. */ @@ -262,12 +210,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Next( } -/*PAGE - * - * _Watchdog_Previous - * - * DESCRIPTION: - * +/** * This routine returns a pointer to the watchdog timer preceding * THE_WATCHDOG on the watchdog chain. */ @@ -281,12 +224,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Previous( } -/*PAGE - * - * _Watchdog_First - * - * DESCRIPTION: - * +/** * This routine returns a pointer to the first watchdog timer * on the watchdog chain HEADER. */ @@ -300,12 +238,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_First( } -/*PAGE - * - * _Watchdog_Last - * - * DESCRIPTION: - * +/** * This routine returns a pointer to the last watchdog timer * on the watchdog chain HEADER. */ @@ -319,5 +252,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Last( } +/**@}*/ + #endif /* end of include file */ |