diff options
Diffstat (limited to 'cpukit/score/include/rtems/score/context.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/context.h | 61 |
1 files changed, 34 insertions, 27 deletions
diff --git a/cpukit/score/include/rtems/score/context.h b/cpukit/score/include/rtems/score/context.h index 5c7e0fa3b9..87c61957ba 100644 --- a/cpukit/score/include/rtems/score/context.h +++ b/cpukit/score/include/rtems/score/context.h @@ -5,7 +5,7 @@ */ /* - * COPYRIGHT (c) 1989-2004. + * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -21,7 +21,7 @@ /** * @defgroup ScoreContext Context Handler * - * This group contains functionality which abstracts thread context + * This handler encapsulates functionality which abstracts thread context * management in a portable manner. */ /**@{*/ @@ -33,14 +33,16 @@ extern "C" { #include <rtems/score/cpu.h> /** - * @ingroup ScoreContext + * @brief Size of Floating Point Context Area + * * This constant defines the number of bytes required * to store a full floating point context. */ #define CONTEXT_FP_SIZE CPU_CONTEXT_FP_SIZE /** - * @ingroup ScoreContext + * @brief Is Context Switch Needed? + * * This variable is set to TRUE when a reschedule operation * has determined that the processor should be taken away from the * currently executing thread and given to the heir thread. @@ -49,54 +51,56 @@ extern "C" { SCORE_EXTERN volatile boolean _Context_Switch_necessary; /** - * @ingroup ScoreContext + * @brief Initialize Context Area * This routine initializes @a _the_context such that the stack * pointer, interrupt level, and entry point are correct for the * thread's initial state. * - * @param _the_context (in) will be initialized - * @param _stack (in) is the lowest physical address of the thread's + * @param[in] _the_context will be initialized + * @param[in] _stack is the lowest physical address of the thread's * context - * @param _size (in) is the size in octets of the thread's context - * @param _isr (in) is the ISR enable level for this thread - * @param _entry (in) is this thread's entry point - * @param _is_fp (in) is set to TRUE if this thread has floating point + * @param[in] _size is the size in octets of the thread's context + * @param[in] _isr is the ISR enable level for this thread + * @param[in] _entry is this thread's entry point + * @param[in] _is_fp is set to TRUE if this thread has floating point * enabled */ -#define \ - _Context_Initialize( _the_context, _stack, _size, _isr, _entry, _is_fp ) \ +#define _Context_Initialize(_the_context, _stack, _size, _isr, _entry, _is_fp) \ _CPU_Context_Initialize( _the_context, _stack, _size, _isr, _entry, _is_fp ) /** - * @ingroup ScoreContext + * @brief Perform Context Switch + * * This routine saves the current context into the @a _executing * context record and restores the context specified by @a _heir. * - * @param _executing (in) is the currently executing thread's context - * @param _heir (in) is the context of the thread to be switched to + * @param[in] _executing is the currently executing thread's context + * @param[in] _heir is the context of the thread to be switched to */ #define _Context_Switch( _executing, _heir ) \ _CPU_Context_switch( _executing, _heir ) /** - * @ingroup ScoreContext + * @brief Restart Currently Executing Thread + * * This routine restarts the calling thread by restoring its initial * stack pointer and returning to the thread's entry point. * - * @param _the_context (in) is the context of the thread to restart + * @param[in] _the_context is the context of the thread to restart */ #define _Context_Restart_self( _the_context ) \ _CPU_Context_Restart_self( _the_context ) /** - * @ingroup ScoreContext + * @brief Return Starting Address of Floating Point Context + * * This function returns the starting address of the floating * point context save area. It is assumed that the are reserved * for the floating point save area is large enough. * - * @param _base (in) is lowest physical address of the floating point + * @param[in] _base is lowest physical address of the floating point * context save area. - * @param _offset (in) is XXX + * @param[in] _offset is the offset into the floating point area * * @return the initial FP context pointer */ @@ -104,34 +108,37 @@ SCORE_EXTERN volatile boolean _Context_Switch_necessary; _CPU_Context_Fp_start( (_base), (_offset) ) /** - * @ingroup ScoreContext + * @brief Initialize Floating Point Context Area + * * This routine initializes the floating point context save * area to contain an initial known state. * - * @param _fp_area (in) is the base address of the floating point + * @param[in] _fp_area is the base address of the floating point * context save area to initialize. */ #define _Context_Initialize_fp( _fp_area ) \ _CPU_Context_Initialize_fp( _fp_area ) /** - * @ingroup ScoreContext + * @brief Restore Floating Point Context Area + * * This routine restores the floating point context contained * in the @a _fp area. It is assumed that the current * floating point context has been saved by a previous invocation * of @a _Context_Save_fp. * - * @param _fp (in) points to the floating point context area to restore. + * @param[in] _fp points to the floating point context area to restore. */ #define _Context_Restore_fp( _fp ) \ _CPU_Context_restore_fp( _fp ) /** - * @ingroup ScoreContext + * @brief Save Floating Point Context Area + * * This routine saves the current floating point context * in the @a _fp area. * - * @param _fp (in) points to the floating point context area to restore. + * @param[in] _fp points to the floating point context area to restore. */ #define _Context_Save_fp( _fp ) \ _CPU_Context_save_fp( _fp ) |