From 18ca4e8b7083e8229c0b628ba3d30778de6d8f9b Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Tue, 29 Jan 2008 23:58:17 +0000 Subject: 2008-01-29 Joel Sherrill * score/Doxyfile: Update to latest Doxygen format. * score/include/rtems/score/apimutex.h, score/include/rtems/score/corebarrier.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/corerwlock.h, score/include/rtems/score/heap.h, score/include/rtems/score/object.h, score/include/rtems/score/protectedheap.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadsync.h, score/include/rtems/score/tod.h, score/inline/rtems/score/corerwlock.inl, score/inline/rtems/score/corespinlock.inl: Remove most doxygen warnings. --- cpukit/score/include/rtems/score/apimutex.h | 4 ++-- cpukit/score/include/rtems/score/corebarrier.h | 6 ++--- cpukit/score/include/rtems/score/coremutex.h | 27 ++++++++++++++++++----- cpukit/score/include/rtems/score/corerwlock.h | 8 +++---- cpukit/score/include/rtems/score/heap.h | 3 +-- cpukit/score/include/rtems/score/object.h | 28 ++++++++++++++---------- cpukit/score/include/rtems/score/protectedheap.h | 6 ++--- cpukit/score/include/rtems/score/thread.h | 4 ++-- cpukit/score/include/rtems/score/threadsync.h | 2 +- cpukit/score/include/rtems/score/tod.h | 25 +++++++++++---------- 10 files changed, 67 insertions(+), 46 deletions(-) (limited to 'cpukit/score/include/rtems/score') diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h index 2a7a3d2305..a0ff68b8d6 100644 --- a/cpukit/score/include/rtems/score/apimutex.h +++ b/cpukit/score/include/rtems/score/apimutex.h @@ -7,7 +7,7 @@ */ /* - * COPYRIGHT (c) 1989-2007. + * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -84,7 +84,7 @@ void _API_Mutex_Lock( /** * This routine releases the specified API mutex. * - * @param[in] _the_mutex is the mutex to release. + * @param[in] the_mutex is the mutex to release. */ void _API_Mutex_Unlock( API_Mutex_Control *the_mutex diff --git a/cpukit/score/include/rtems/score/corebarrier.h b/cpukit/score/include/rtems/score/corebarrier.h index 3b6b833ce3..ec1dd946fd 100644 --- a/cpukit/score/include/rtems/score/corebarrier.h +++ b/cpukit/score/include/rtems/score/corebarrier.h @@ -176,10 +176,10 @@ uint32_t _CORE_barrier_Release( * This routine assists in the deletion of a barrier by flushing the * associated wait queue. * - * @param[in] the_barrier is the barrier to flush - * @param[in] remote_extract_callout is the routine to invoke if the + * @param[in] _the_barrier is the barrier to flush + * @param[in] _remote_extract_callout is the routine to invoke if the * thread unblocked is remote - * @param[in] status is the status to be returned to the unblocked thread + * @param[in] _status is the status to be returned to the unblocked thread */ #define _CORE_barrier_Flush( _the_barrier, _remote_extract_callout, _status) \ _Thread_queue_Flush( \ diff --git a/cpukit/score/include/rtems/score/coremutex.h b/cpukit/score/include/rtems/score/coremutex.h index 5f6627f932..cf46e9265c 100644 --- a/cpukit/score/include/rtems/score/coremutex.h +++ b/cpukit/score/include/rtems/score/coremutex.h @@ -8,7 +8,7 @@ */ /* - * COPYRIGHT (c) 1989-2007. + * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -292,23 +292,29 @@ RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock_body( ); #if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__) - /* + /** * When doing test coverage analysis or trying to minimize the code * space for RTEMS, it is often helpful to not inline this method * multiple times. It is fairly large and has a high branch complexity * which makes it harder to get full binary test coverage. + * + * @param[in] the_mutex will attempt to lock + * @param[in] level_p is the interrupt level holder */ int _CORE_mutex_Seize_interrupt_trylock( CORE_mutex_Control *the_mutex, ISR_Level *level_p ); #else - /* + /** * The default is to favor speed and inlining this definitely saves * a few instructions. This is very important for mutex performance. + * + * @param[in] _mutex will attempt to lock + * @param[in] _level_p is the interrupt level holder */ - #define _CORE_mutex_Seize_interrupt_trylock( _mutex, _level ) \ - _CORE_mutex_Seize_interrupt_trylock_body( _mutex, _level ) + #define _CORE_mutex_Seize_interrupt_trylock( _mutex, _level_p ) \ + _CORE_mutex_Seize_interrupt_trylock_body( _mutex, _level_p ) #endif /** @@ -344,7 +350,6 @@ void _CORE_mutex_Seize_interrupt_blocking( * with context switching disabled, or before multitasking, * then a fatal error is generated. * - * * The logic on this routine is as follows: * * * If incorrect system state @@ -384,6 +389,16 @@ void _CORE_mutex_Seize_interrupt_blocking( } \ } while (0) +/** + * This method is used to obtain a core mutex. + * + * @param[in] _the_mutex is the mutex to attempt to lock + * @param[in] _id is the Id of the owning API level Semaphore object + * @param[in] _wait is TRUE if the thread is willing to wait + * @param[in] _timeout is the maximum number of ticks to block + * @param[in] _level is a temporary variable used to contain the ISR + * disable level cookie + */ #if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__) void _CORE_mutex_Seize( CORE_mutex_Control *_the_mutex, diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h index 60c966529b..ac57a02baa 100644 --- a/cpukit/score/include/rtems/score/corerwlock.h +++ b/cpukit/score/include/rtems/score/corerwlock.h @@ -6,7 +6,7 @@ */ /* - * COPYRIGHT (c) 1989-2006. + * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -193,10 +193,10 @@ CORE_RWLock_Status _CORE_RWLock_Release( * This routine assists in the deletion of a RWLock by flushing the * associated wait queue. * - * @param[in] the_rwlock is the RWLock to flush - * @param[in] remote_extract_callout is the routine to invoke if the + * @param[in] _the_rwlock is the RWLock to flush + * @param[in] _remote_extract_callout is the routine to invoke if the * thread unblocked is remote - * @param[in] status is the status to be returned to the unblocked thread + * @param[in] _status is the status to be returned to the unblocked thread */ #define _CORE_RWLock_Flush( _the_rwlock, _remote_extract_callout, _status) \ _Thread_queue_Flush( \ diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h index 4c5ecfb58f..db7e32355c 100644 --- a/cpukit/score/include/rtems/score/heap.h +++ b/cpukit/score/include/rtems/score/heap.h @@ -141,8 +141,7 @@ struct Heap_Block_struct { * rather small. Feel free to make it compile-time option if you think * the overhead is too high for your application. */ - -typedef struct Heap_Statistics_tag { +typedef struct { /** instance number of this heap */ uint32_t instance; /** the size of the memory for heap */ diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index ffc34a46a0..aa3218adc0 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -429,6 +429,7 @@ SCORE_EXTERN Objects_Information */ #define OBJECTS_ID_FINAL ((Objects_Id)~0) +#if defined(RTEMS_MULTIPROCESSING) /** * This function performs the initialization necessary for this handler. * @@ -438,12 +439,16 @@ SCORE_EXTERN Objects_Information * concurrently offered in the system. */ void _Objects_Handler_initialization( -#if defined(RTEMS_MULTIPROCESSING) uint32_t node, uint32_t maximum_nodes, uint32_t maximum_global_objects -#endif ); +#else +/** + * This function performs the initialization necessary for this handler. + */ +void _Objects_Handler_initialization(void); +#endif /** * This function extends an object class information record. @@ -499,7 +504,7 @@ void _Objects_Initialize_information ( /** * This function returns the highest numeric value of a valid - * API for the specified @code{api}. + * API for the specified @a api. * * @param[in] api is the API of interest * @@ -550,7 +555,7 @@ void _Objects_Free( /** * This macro is used to build a thirty-two bit style name from * four characters. The most significant byte will be the - * character @code{_C1}. + * character @a _C1. * * @param[in] _C1 is the first character of the name * @param[in] _C2 is the second character of the name @@ -581,12 +586,14 @@ typedef enum { OBJECTS_INVALID_NODE } Objects_Name_or_id_lookup_errors; -/** This macro defines the first entry in the +/** + * This macro defines the first entry in the * @ref Objects_Name_or_id_lookup_errors enumerated list. */ #define OBJECTS_NAME_ERRORS_FIRST OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL -/** This macro defines the last entry in the +/** + * This macro defines the last entry in the * @ref Objects_Name_or_id_lookup_errors enumerated list. */ #define OBJECTS_NAME_ERRORS_LAST OBJECTS_INVALID_NODE @@ -797,8 +804,7 @@ Objects_Control *_Objects_Get_next( * the existence of any objects created by the API. * * @param[in] api indicates the API for the information we want - * @param[in] api indicates the Class for the information we want - * + * @param[in] class indicates the Class for the information we want * * @return This method returns a pointer to the Object Information Table * for the class of objects which corresponds to this object ID. @@ -814,7 +820,6 @@ Objects_Information *_Objects_Get_information( * * @param[in] id is an object ID * - * * @return This method returns a pointer to the Object Information Table * for the class of objects which corresponds to this object ID. */ @@ -829,9 +834,10 @@ Objects_Information *_Objects_Get_information_id( * * @param[in] id is the object to obtain the name of * @param[in] length indicates the length of the caller's buffer - * @param[inout] name is a string which will be filled in. + * @param[in] name points a string which will be filled in. * - * @return This method returns @a name or NULL on error. + * @return This method returns @a name or NULL on error. @a *name will + * contain the name if successful. */ char *_Objects_Get_name_as_string( Objects_Id id, diff --git a/cpukit/score/include/rtems/score/protectedheap.h b/cpukit/score/include/rtems/score/protectedheap.h index b41bc6fcec..8870262b33 100644 --- a/cpukit/score/include/rtems/score/protectedheap.h +++ b/cpukit/score/include/rtems/score/protectedheap.h @@ -139,9 +139,9 @@ boolean _Protected_heap_Get_block_size( * @param[in] starting_address is the starting address of the user block * to be resized * @param[in] size is the new size - * @param[in] old_mem_size points to a user area to return the size of the - * @return TRUE if successfully able to resize the block, - * FALSE if the block can't be resized in place, + * + * @return TRUE if successfully able to resize the block. + * FALSE if the block can't be resized in place. */ boolean _Protected_heap_Resize_block( Heap_Control *the_heap, diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h index fcf26c9507..a767fe09fe 100644 --- a/cpukit/score/include/rtems/score/thread.h +++ b/cpukit/score/include/rtems/score/thread.h @@ -36,8 +36,8 @@ extern "C" { * resolution. */ #ifndef __RTEMS_USE_TICKS_CPU_USAGE_STATISTICS__ - /* - * Enable the nanosecond accurate statistics + /** + * This macro enables the nanosecond accurate statistics * * When not defined, the older style tick accurate granularity * is used. diff --git a/cpukit/score/include/rtems/score/threadsync.h b/cpukit/score/include/rtems/score/threadsync.h index 6902f7b33b..aa71d5c1a8 100644 --- a/cpukit/score/include/rtems/score/threadsync.h +++ b/cpukit/score/include/rtems/score/threadsync.h @@ -21,7 +21,7 @@ #define _RTEMS_SCORE_THREAD_SYNC_H /** - * @defgroup ScoreThread Thread Blocking Operation Synchronization Handler + * @defgroup ScoreThreadSync Thread Blocking Operation Synchronization Handler * * This handler encapsulates functionality related to the management of * synchronization critical sections during blocking operations. diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h index f98c2c49fd..93cd2cb514 100644 --- a/cpukit/score/include/rtems/score/tod.h +++ b/cpukit/score/include/rtems/score/tod.h @@ -6,7 +6,7 @@ */ /* - * COPYRIGHT (c) 1989-2007. + * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -19,13 +19,6 @@ #ifndef _RTEMS_SCORE_TOD_H #define _RTEMS_SCORE_TOD_H -/** - * @defgroup ScoreTOD Time Of Day (TOD) Handler - * - * This handler encapsulates functionality used to manage time of day. - */ -/**@{*/ - #ifdef __cplusplus extern "C" { #endif @@ -34,7 +27,8 @@ extern "C" { #include /** @defgroup ScoreTODConstants TOD Constants - * The following constants are related to the time of day. + * The following constants are related to the time of day and are + * independent of RTEMS. */ /**@{*/ @@ -96,7 +90,9 @@ extern "C" { */ #define TOD_NANOSECONDS_PER_MICROSECOND (uint32_t)1000 -/* +/**@}*/ + +/** * Seconds from January 1, 1970 to January 1, 1988. Used to account for * differences between POSIX API and RTEMS core. The timespec format time * is kept in POSIX compliant form. @@ -105,8 +101,6 @@ extern "C" { (((1987 - 1970 + 1) * TOD_SECONDS_PER_NON_LEAP_YEAR) + \ (4 * TOD_SECONDS_PER_DAY)) -/**@}*/ - /** @brief Ticks per Second * * This macro calculates the number of ticks per second. @@ -123,6 +117,13 @@ extern "C" { */ #define TOD_BASE_YEAR 1988 +/** + * @defgroup ScoreTOD Time Of Day (TOD) Handler + * + * This handler encapsulates functionality used to manage time of day. + */ +/**@{*/ + /** @brief Is the Time Of Day Set * * This is TRUE if the application has set the current -- cgit v1.2.3