From baff4dafe1ff85d128a55e7b73780ca28f5c7faf Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 1 Nov 2004 13:22:41 +0000 Subject: 2004-11-01 Joel Sherrill * score/cpu/no_cpu/rtems/score/cpu.h, score/include/rtems/debug.h, score/include/rtems/seterr.h, score/include/rtems/system.h, score/include/rtems/score/address.h, score/include/rtems/score/apiext.h, score/include/rtems/score/apimutex.h, score/include/rtems/score/bitfield.h, score/include/rtems/score/chain.h, score/include/rtems/score/context.h, score/include/rtems/score/copyrt.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/coresem.h, score/include/rtems/score/heap.h, score/include/rtems/score/interr.h, score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h, score/include/rtems/score/objectmp.h, score/include/rtems/score/priority.h, score/include/rtems/score/stack.h, score/include/rtems/score/states.h, score/include/rtems/score/sysstate.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadmp.h, score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h, score/include/rtems/score/userext.h, score/include/rtems/score/watchdog.h, score/include/rtems/score/wkspace.h, score/inline/rtems/score/address.inl, score/inline/rtems/score/chain.inl, score/inline/rtems/score/coremsg.inl, score/inline/rtems/score/coremutex.inl, score/inline/rtems/score/coresem.inl, score/inline/rtems/score/heap.inl, score/inline/rtems/score/isr.inl, score/inline/rtems/score/mppkt.inl, score/inline/rtems/score/objectmp.inl, score/inline/rtems/score/priority.inl, score/inline/rtems/score/stack.inl, score/inline/rtems/score/states.inl, score/inline/rtems/score/sysstate.inl, score/inline/rtems/score/thread.inl, score/inline/rtems/score/threadmp.inl, score/inline/rtems/score/tod.inl, score/inline/rtems/score/tqdata.inl, score/inline/rtems/score/userext.inl, score/inline/rtems/score/watchdog.inl, score/inline/rtems/score/wkspace.inl: Add Doxygen comments -- working modifications which are not complete and may have broken code. Committing so work and testing can proceed. * score/Doxyfile, score/mainpage.h: New files. --- cpukit/score/inline/rtems/score/thread.inl | 172 ++++++----------------------- 1 file changed, 36 insertions(+), 136 deletions(-) (limited to 'cpukit/score/inline/rtems/score/thread.inl') diff --git a/cpukit/score/inline/rtems/score/thread.inl b/cpukit/score/inline/rtems/score/thread.inl index e4f113f70c..3d38f8e6da 100644 --- a/cpukit/score/inline/rtems/score/thread.inl +++ b/cpukit/score/inline/rtems/score/thread.inl @@ -1,9 +1,12 @@ -/* thread.inl +/** + * @file thread.inl * * This file contains the macro implementation of the inlined * routines from the Thread 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 __THREAD_inl #define __THREAD_inl -/*PAGE - * - * _Thread_Stop_multitasking - * - * DESCRIPTION: - * +/** + * @addtogroup ScoreThread + * @{ + */ + +/** * This routine halts multitasking and returns control to * the "thread" (i.e. the BSP) which initially invoked the * routine which initialized the system. @@ -32,12 +35,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Stop_multitasking( void ) _Context_Switch( &_Thread_Executing->Registers, &_Thread_BSP_context ); } -/*PAGE - * - * _Thread_Is_executing - * - * DESCRIPTION: - * +/** * This function returns TRUE if the_thread is the currently executing * thread, and FALSE otherwise. */ @@ -49,12 +47,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_executing ( return ( the_thread == _Thread_Executing ); } -/*PAGE - * - * _Thread_Is_heir - * - * DESCRIPTION: - * +/** * This function returns TRUE if the_thread is the heir * thread, and FALSE otherwise. */ @@ -66,12 +59,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_heir ( return ( the_thread == _Thread_Heir ); } -/*PAGE - * - * _Thread_Is_executing_also_the_heir - * - * DESCRIPTION: - * +/** * This function returns TRUE if the currently executing thread * is also the heir thread, and FALSE otherwise. */ @@ -81,12 +69,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_executing_also_the_heir( void ) return ( _Thread_Executing == _Thread_Heir ); } -/*PAGE - * - * _Thread_Unblock - * - * DESCRIPTION: - * +/** * This routine clears any blocking state for the_thread. It performs * any necessary scheduling operations including the selection of * a new heir thread. @@ -99,12 +82,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Unblock ( _Thread_Clear_state( the_thread, STATES_BLOCKED ); } -/*PAGE - * - * _Thread_Restart_self - * - * DESCRIPTION: - * +/** * This routine resets the current context of the calling thread * to that of its initial state. */ @@ -119,12 +97,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Restart_self( void ) _CPU_Context_Restart_self( &_Thread_Executing->Registers ); } -/*PAGE - * - * _Thread_Calculate_heir - * - * DESCRIPTION: - * +/** * This function returns a pointer to the highest priority * ready thread. */ @@ -135,12 +108,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Calculate_heir( void ) _Thread_Ready_chain[ _Priority_Get_highest() ].first; } -/*PAGE - * - * _Thread_Is_allocated_fp - * - * DESCRIPTION: - * +/** * This function returns TRUE if the floating point context of * the_thread is currently loaded in the floating point unit, and * FALSE otherwise. @@ -155,12 +123,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_allocated_fp ( } #endif -/*PAGE - * - * _Thread_Deallocate_fp - * - * DESCRIPTION: - * +/** * This routine is invoked when the currently loaded floating * point context is now longer associated with an active thread. */ @@ -172,12 +135,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Deallocate_fp( void ) } #endif -/*PAGE - * - * _Thread_Disable_dispatch - * - * DESCRIPTION: - * +/** * This routine prevents dispatching. */ @@ -186,12 +144,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Disable_dispatch( void ) _Thread_Dispatch_disable_level += 1; } -/*PAGE - * - * _Thread_Enable_dispatch - * - * DESCRIPTION: - * +/** * This routine allows dispatching to occur again. If this is * the outer most dispatching critical section, then a dispatching * operation will be performed and, if necessary, control of the @@ -210,12 +163,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Enable_dispatch() void _Thread_Enable_dispatch( void ); #endif -/*PAGE - * - * _Thread_Unnest_dispatch - * - * DESCRIPTION: - * +/** * This routine allows dispatching to occur again. However, * no dispatching operation is performed even if this is the outer * most dispatching critical section. @@ -226,12 +174,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Unnest_dispatch( void ) _Thread_Dispatch_disable_level -= 1; } -/*PAGE - * - * _Thread_Is_dispatching_enabled - * - * DESCRIPTION: - * +/** * This function returns TRUE if dispatching is disabled, and FALSE * otherwise. */ @@ -241,12 +184,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_dispatching_enabled( void ) return ( _Thread_Dispatch_disable_level == 0 ); } -/*PAGE - * - * _Thread_Is_context_switch_necessary - * - * DESCRIPTION: - * +/** * This function returns TRUE if dispatching is disabled, and FALSE * otherwise. */ @@ -256,12 +194,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_context_switch_necessary( void ) return ( _Context_Switch_necessary ); } -/*PAGE - * - * _Thread_Dispatch_initialization - * - * DESCRIPTION: - * +/** * This routine initializes the thread dispatching subsystem. */ @@ -270,12 +203,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Dispatch_initialization( void ) _Thread_Dispatch_disable_level = 1; } -/*PAGE - * - * _Thread_Is_null - * - * DESCRIPTION: - * +/** * This function returns TRUE if the_thread is NULL and FALSE otherwise. */ @@ -286,12 +214,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_null ( return ( the_thread == NULL ); } -/*PAGE - * - * _Thread_Get - * - * DESCRIPTION: - * +/** * This function maps thread IDs to thread control * blocks. If ID corresponds to a local thread, then it * returns the_thread control pointer which maps to ID @@ -301,7 +224,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_null ( * Otherwise, location is set to OBJECTS_ERROR and * the_thread is undefined. * - * NOTE: XXX... This routine may be able to be optimized. + * @note XXX... This routine may be able to be optimized. */ RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Get ( @@ -347,15 +270,10 @@ done: } -/* - * _Thread_Is_proxy_blocking +/** @brief _Thread_Is_proxy_blocking * - * DESCRIPTION: - * - * This function returns TRUE if the status code is equal to the * status which indicates that a proxy is blocking, and FALSE otherwise. */ - RTEMS_INLINE_ROUTINE boolean _Thread_Is_proxy_blocking ( uint32_t code ) @@ -363,12 +281,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_proxy_blocking ( return (code == THREAD_STATUS_PROXY_BLOCKING); } -/*PAGE - * - * _Thread_Internal_allocate - * - * DESCRIPTION: - * +/** * This routine allocates an internal thread. */ @@ -377,12 +290,7 @@ RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Internal_allocate( void ) return (Thread_Control *) _Objects_Allocate( &_Thread_Internal_information ); } -/*PAGE - * - * _Thread_Internal_free - * - * DESCRIPTION: - * +/** * This routine frees an internal thread. */ @@ -393,12 +301,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Internal_free ( _Objects_Free( &_Thread_Internal_information, &the_task->Object ); } -/*PAGE - * - * _Thread_Get_libc_reent - * - * DESCRIPTION: - * +/** * This routine returns the C library re-enterant pointer. */ @@ -407,12 +310,7 @@ RTEMS_INLINE_ROUTINE struct _reent **_Thread_Get_libc_reent( void ) return _Thread_libc_reent; } -/*PAGE - * - * _Thread_Set_libc_reent - * - * DESCRIPTION: - * +/** * This routine set the C library re-enterant pointer. */ @@ -423,5 +321,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Set_libc_reent ( _Thread_libc_reent = libc_reent; } +/**@}*/ + #endif /* end of include file */ -- cgit v1.2.3