[rtems commit] score misc: Score misc: Clean up Doxygen #9 (GCI 2012)
Joel Sherrill
joel at rtems.org
Fri Nov 30 21:31:05 UTC 2012
Module: rtems
Branch: master
Commit: e0f91da505b5c907b545016645c07a3132696236
Changeset: http://git.rtems.org/rtems/commit/?id=e0f91da505b5c907b545016645c07a3132696236
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Fri Nov 30 15:34:17 2012 -0600
score misc: Score misc: Clean up Doxygen #9 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
https://google-melange.appspot.com/gci/task/view/google/gci2012/7977211
---
cpukit/score/cpu/h8300/cpu.c | 29 ++---------
cpukit/score/cpu/lm32/cpu.c | 36 ++------------
cpukit/score/cpu/lm32/irq.c | 16 ++----
cpukit/score/cpu/m32c/cpu.c | 19 ++-----
cpukit/score/cpu/m32c/cpu_asm.c | 6 ++
cpukit/score/cpu/mips/cpu.c | 46 +++---------------
cpukit/score/cpu/sparc/cpu.c | 50 ++-----------------
cpukit/score/cpu/sparc64/cpu.c | 27 +++--------
cpukit/score/include/rtems/score/corebarrier.h | 4 +-
cpukit/score/include/rtems/score/coremutex.h | 6 +--
cpukit/score/include/rtems/score/isr.h | 12 ++++-
cpukit/score/include/rtems/score/object.h | 3 +-
.../score/include/rtems/score/schedulerpriority.h | 14 ++++--
cpukit/score/include/rtems/score/thread.h | 46 +++++++++---------
cpukit/score/include/rtems/score/threadq.h | 38 +++++++++------
cpukit/score/include/rtems/score/timespec.h | 2 +-
cpukit/score/include/rtems/score/watchdog.h | 2 +-
cpukit/score/src/corebarrier.c | 26 +++-------
cpukit/score/src/coremutexseize.c | 25 +++-------
cpukit/score/src/objectfree.c | 19 +++-----
cpukit/score/src/scheduleredfallocate.c | 7 +++
cpukit/score/src/scheduleredfupdate.c | 7 +++
cpukit/score/src/schedulerpriorityenqueue.c | 7 +++
cpukit/score/src/schedulerpriorityfree.c | 9 +++-
cpukit/score/src/thread.c | 20 +++-----
cpukit/score/src/threadqdequeuefifo.c | 26 +++-------
cpukit/score/src/threadqfirstfifo.c | 23 +++------
cpukit/score/src/timespecaddto.c | 11 ++---
cpukit/score/src/watchdognanoseconds.c | 7 +++
29 files changed, 202 insertions(+), 341 deletions(-)
diff --git a/cpukit/score/cpu/h8300/cpu.c b/cpukit/score/cpu/h8300/cpu.c
index 558947b..3836e52 100644
--- a/cpukit/score/cpu/h8300/cpu.c
+++ b/cpukit/score/cpu/h8300/cpu.c
@@ -1,6 +1,10 @@
-/*
- * Hitachi H8300 CPU Dependent Source
+/**
+ * @file
*
+ * @brief H8300 CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -37,12 +41,6 @@ void _CPU_Initialize(void)
/* FP context initialization support goes here */
}
-/*
- * _CPU_ISR_Get_level
- *
- * This routine returns the current interrupt level.
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
unsigned int _ccr;
@@ -76,21 +74,6 @@ void _CPU_ISR_install_raw_handler(
H8BD_Install_IRQ(vector,new_handler,old_handler);
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * old_handler - former ISR for this vector number
- * new_handler - replacement ISR for this vector number
- *
- * Output parameters: NONE
- *
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
diff --git a/cpukit/score/cpu/lm32/cpu.c b/cpukit/score/cpu/lm32/cpu.c
index d668dd4..6df5576 100644
--- a/cpukit/score/cpu/lm32/cpu.c
+++ b/cpukit/score/cpu/lm32/cpu.c
@@ -1,7 +1,10 @@
-/*
- * Lattice Mico32 (lm32) CPU Dependent Source
- *
+/**
+ * @file
*
+ * @brief LM32 CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -44,14 +47,6 @@ void _CPU_Initialize(void)
/* FP context initialization support goes here */
}
-/*
- * _CPU_ISR_Get_level
- *
- * LM32 Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
/*
@@ -81,25 +76,6 @@ void _CPU_ISR_install_raw_handler(
*/
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * old_handler - former ISR for this vector number
- * new_handler - replacement ISR for this vector number
- *
- * Output parameters: NONE
- *
- *
- * LM32 Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
diff --git a/cpukit/score/cpu/lm32/irq.c b/cpukit/score/cpu/lm32/irq.c
index a601ded..37e9a28 100644
--- a/cpukit/score/cpu/lm32/irq.c
+++ b/cpukit/score/cpu/lm32/irq.c
@@ -1,8 +1,10 @@
-/*
- * lm32 interrupt handler
- *
- * Derived from c4x/irq.c and nios2/irq.c
+/**
+ * @file
*
+ * @brief LM32 Initialize the ISR Handler
+ */
+
+/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,12 +23,6 @@
#include <rtems/score/isr.h>
#include <rtems/score/percpu.h>
-/*
- * This routine provides the RTEMS interrupt management.
- *
- * Upon entry, interrupts are disabled
- */
-
#if( CPU_HAS_SOFTWARE_INTERRUPT_STACK == TRUE)
unsigned long *_old_stack_ptr;
#endif
diff --git a/cpukit/score/cpu/m32c/cpu.c b/cpukit/score/cpu/m32c/cpu.c
index 4447cab..afce6f0 100644
--- a/cpukit/score/cpu/m32c/cpu.c
+++ b/cpukit/score/cpu/m32c/cpu.c
@@ -1,6 +1,10 @@
-/*
- * XXX CPU Dependent Source
+/**
+ * @file
*
+ * @brief M32C CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -79,17 +83,6 @@ void _CPU_ISR_install_raw_handler(
/*
* _CPU_ISR_install_vector
*
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * old_handler - former ISR for this vector number
- * new_handler - replacement ISR for this vector number
- *
- * Output parameters: NONE
- *
- *
* NO_CPU Specific Information:
*
* XXX document implementation including references if appropriate
diff --git a/cpukit/score/cpu/m32c/cpu_asm.c b/cpukit/score/cpu/m32c/cpu_asm.c
index e6a40ee..898390c 100644
--- a/cpukit/score/cpu/m32c/cpu_asm.c
+++ b/cpukit/score/cpu/m32c/cpu_asm.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief M32C CPU Assembly File
+ */
+
/* cpu_asm.c ===> cpu_asm.S or cpu_asm.s
*
* This file contains the basic algorithms for all assembly code used
diff --git a/cpukit/score/cpu/mips/cpu.c b/cpukit/score/cpu/mips/cpu.c
index 657e53e..5f7abeb 100644
--- a/cpukit/score/cpu/mips/cpu.c
+++ b/cpukit/score/cpu/mips/cpu.c
@@ -1,7 +1,11 @@
/**
* @file
- *
- * Mips CPU Dependent Source
+ *
+ * @brief MIPS CPU Dependent Source
+ */
+
+/*
+ * MIPS CPU Dependent Source
*
* 2002: Greg Menke (gregory.menke at gsfc.nasa.gov)
* Overhauled interrupt level and interrupt enable/disable code
@@ -19,9 +23,7 @@
* wrote the JMR3904 BSP so this could be tested. Joel also
* added the new interrupt vectoring support in libcpu and
* tried to better support the various interrupt controllers.
- */
-
-/*
+ *
* Original MIP64ORION port by Craig Lebakken <craigl at transition.com>
* COPYRIGHT (c) 1996 by Transition Networks Inc.
*
@@ -65,10 +67,6 @@ typedef uint64_t ESF_PTR_TYPE;
#endif
ESF_PTR_TYPE __exceptionStackFrame = 0;
-
-
-
-
/* _CPU_Initialize
*
* This routine performs processor dependent initialization.
@@ -93,12 +91,6 @@ void _CPU_Initialize(void)
#endif
}
-/*
- * _CPU_ISR_Get_level
- *
- * This routine returns the current interrupt level.
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
unsigned int sr;
@@ -120,8 +112,6 @@ uint32_t _CPU_ISR_Get_level( void )
#endif
return sr;
}
-
-
void _CPU_ISR_Set_level( uint32_t new_level )
{
unsigned int sr, srbits;
@@ -172,31 +162,11 @@ void _CPU_ISR_Set_level( uint32_t new_level )
mips_set_sr( sr );
}
-/*
- * _CPU_Install_interrupt_stack
- */
-
void _CPU_Install_interrupt_stack( void )
{
/* we don't support this yet */
}
-/*
- * _CPU_Context_Initialize
- *
- * This kernel routine initializes the basic non-FP context area associated
- * with each thread.
- *
- * Input parameters:
- * the_context - pointer to the context area
- * stack_base - address of memory for the SPARC
- * size - size in bytes of the stack area
- * new_level - interrupt level for this context area
- * entry_point - the starting execution point for this this context
- * is_fp - TRUE if this context is associated with an FP thread
- *
- * Output parameters: NONE
- */
void _CPU_Context_Initialize(
Context_Control *the_context,
uintptr_t *stack_base,
@@ -222,8 +192,6 @@ void _CPU_Context_Initialize(
((intlvl & 1)?_INTON:0)) ) |
SR_CU0 | ((is_fp)?SR_CU1:0) | _EXTRABITS;
}
-
-
/*
* _CPU_Internal_threads_Idle_thread_body
*
diff --git a/cpukit/score/cpu/sparc/cpu.c b/cpukit/score/cpu/sparc/cpu.c
index 7891726..baa15c0 100644
--- a/cpukit/score/cpu/sparc/cpu.c
+++ b/cpukit/score/cpu/sparc/cpu.c
@@ -1,6 +1,10 @@
-/*
- * SPARC Dependent Source
+/**
+ * @file
*
+ * @brief SPARC CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -70,15 +74,6 @@ void _CPU_Initialize(void)
_CPU_ISR_Dispatch_disable = 0;
}
-/*
- * _CPU_ISR_Get_level
- *
- * Input Parameters: NONE
- *
- * Output Parameters:
- * returns the current interrupt level (PIL field of the PSR)
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
uint32_t level;
@@ -195,22 +190,6 @@ void _CPU_ISR_install_raw_handler(
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * new_handler - replacement ISR for this vector number
- * old_handler - pointer to former ISR for this vector number
- *
- * Output parameters:
- * *old_handler - former ISR for this vector number
- *
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
@@ -247,23 +226,6 @@ void _CPU_ISR_install_vector(
_ISR_Vector_table[ real_vector ] = new_handler;
}
-/*
- * _CPU_Context_Initialize
- *
- * This kernel routine initializes the basic non-FP context area associated
- * with each thread.
- *
- * Input parameters:
- * the_context - pointer to the context area
- * stack_base - address of memory for the SPARC
- * size - size in bytes of the stack area
- * new_level - interrupt level for this context area
- * entry_point - the starting execution point for this this context
- * is_fp - TRUE if this context is associated with an FP thread
- *
- * Output parameters: NONE
- */
-
void _CPU_Context_Initialize(
Context_Control *the_context,
uint32_t *stack_base,
diff --git a/cpukit/score/cpu/sparc64/cpu.c b/cpukit/score/cpu/sparc64/cpu.c
index ac35dc4..94f9340 100644
--- a/cpukit/score/cpu/sparc64/cpu.c
+++ b/cpukit/score/cpu/sparc64/cpu.c
@@ -1,10 +1,14 @@
-/*
- * SPARC-v9 Dependent Source
+/**
+ * @file
*
+ * @brief SPARC64 CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
- * This file is based on the SPARC cpu.c file. Modifications are made to
+ * This file is based on the SPARC cpu.c file. Modifications are made to
* provide support for the SPARC-v9.
* COPYRIGHT (c) 2010. Gedare Bloom.
*
@@ -55,23 +59,6 @@ void _CPU_Initialize(void)
_CPU_ISR_Dispatch_disable = 0;
}
-/*
- * _CPU_Context_Initialize
- *
- * This kernel routine initializes the basic non-FP context area associated
- * with each thread.
- *
- * Input parameters:
- * the_context - pointer to the context area
- * stack_base - address of memory for the SPARC
- * size - size in bytes of the stack area
- * new_level - interrupt level for this context area
- * entry_point - the starting execution point for this this context
- * is_fp - TRUE if this context is associated with an FP thread
- *
- * Output parameters: NONE
- */
-
void _CPU_Context_Initialize(
Context_Control *the_context,
void *stack_base,
diff --git a/cpukit/score/include/rtems/score/corebarrier.h b/cpukit/score/include/rtems/score/corebarrier.h
index a297805..7f9c5d8 100644
--- a/cpukit/score/include/rtems/score/corebarrier.h
+++ b/cpukit/score/include/rtems/score/corebarrier.h
@@ -121,6 +121,8 @@ typedef struct {
} CORE_barrier_Control;
/**
+ * @brief Initialize CORE Barrier
+ *
* This routine initializes the barrier based on the parameters passed.
*
* @param[in] the_barrier is the barrier to initialize
@@ -157,7 +159,7 @@ void _CORE_barrier_Wait(
/**
* @brief Manually releases the barrier
- *
+ *
* This routine manually releases the barrier. All of the threads waiting
* for the barrier will be readied.
*
diff --git a/cpukit/score/include/rtems/score/coremutex.h b/cpukit/score/include/rtems/score/coremutex.h
index 01a0dd5..8076a37 100644
--- a/cpukit/score/include/rtems/score/coremutex.h
+++ b/cpukit/score/include/rtems/score/coremutex.h
@@ -18,8 +18,6 @@
#ifndef _RTEMS_SCORE_COREMUTEX_H
#define _RTEMS_SCORE_COREMUTEX_H
-
-
/**
* @defgroup ScoreMutex Mutex Handler
*
@@ -336,13 +334,11 @@ void _CORE_mutex_Seize_interrupt_blocking(
CORE_mutex_Control *the_mutex,
Watchdog_Interval timeout
);
-
-
/**
* @brief Sieze Interrupt Wrapper
*
* This macro is to verify that a mutex blocking seize is
- * performed from a safe system state. For example, one
+ * performed from a safe system state. For example, one
* cannot block inside an isr.
*
* @return this method returns true if dispatch is in an unsafe state.
diff --git a/cpukit/score/include/rtems/score/isr.h b/cpukit/score/include/rtems/score/isr.h
index 8a05749..0d93d29 100644
--- a/cpukit/score/include/rtems/score/isr.h
+++ b/cpukit/score/include/rtems/score/isr.h
@@ -50,7 +50,7 @@ typedef void ISR_Handler;
#if (CPU_SIMPLE_VECTORED_INTERRUPTS == FALSE)
-typedef void * ISR_Handler_entry;
+typedef void * ISR_Handler_entry;
#else
/**
@@ -87,7 +87,7 @@ SCORE_EXTERN ISR_Handler_entry *_ISR_Vector_table;
#endif
/**
- * @brief Initialize the ISR handler
+ * @brief Initialize the ISR Handler
*
* This routine performs the initialization necessary for the ISR handler.
*/
@@ -232,7 +232,7 @@ int _ISR_SMP_Exit(void);
#define _ISR_Disable( _level ) \
_ISR_Disable_on_this_core( _level );
#endif
-
+
/**
* @brief Exits Interrupt Disable Critical Section
*
@@ -281,6 +281,9 @@ int _ISR_SMP_Exit(void);
* for the specified vector. The previous interrupt service routine is
* returned as old_handler.
*
+ * LM32 Specific Information:
+ * XXX document implementation including references if appropriate
+ *
* @param[in] _vector is the vector number
* @param[in] _new_handler is ISR handler to install
* @param[in] _old_handler is a pointer to a variable which will be set
@@ -296,6 +299,9 @@ int _ISR_SMP_Exit(void);
*
* This routine returns the current interrupt level.
*
+ * LM32 Specific Information:
+ * XXX document implementation including references if appropriate
+ *
* @return This method returns the current level.
*/
#define _ISR_Get_level() \
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 29c98a8..6d43b39 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -135,8 +135,6 @@ typedef uint16_t Objects_Maximum;
* the object Id.
*/
#define OBJECTS_INDEX_START_BIT 0U
-
-
/**
* This is the bit position of the starting bit of the node portion of
* the object Id.
@@ -525,6 +523,7 @@ Objects_Control *_Objects_Allocate(
);
/**
+ * @brief Free Object
*
* This function frees a object control block to the
* inactive chain of free object control blocks.
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index b8dee43..f959c0e 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -70,7 +70,7 @@ void _Scheduler_priority_Initialize(void);
/**
* @brief Scheduler priority Block
- *
+ *
* This routine removes @a the_thread from the scheduling decision,
* that is, removes it from the ready queue. It performs
* any necessary scheduling operations including the selection of
@@ -103,6 +103,8 @@ void * _Scheduler_priority_Allocate(
);
/**
+ * @brief Free Scheduler Priority
+ *
* This routine frees @a the_thread->scheduler.
*
* @param[in] the_thread is the thread whose scheduler specific information
@@ -113,7 +115,7 @@ void _Scheduler_priority_Free(
);
/**
- * @brief Update Scheduler priority
+ * @brief Update Scheduler priority
* This routine updates @a the_thread->scheduler based on @a the_scheduler
* structures and thread state.
*
@@ -126,7 +128,7 @@ void _Scheduler_priority_Update(
/**
* @brief Scheduler Priority Unblock
- *
+ *
* This routine adds @a the_thread to the scheduling decision,
* that is, adds it to the ready queue and
* updates any appropriate scheduling variables, for example the heir thread.
@@ -149,7 +151,7 @@ void _Scheduler_priority_Unblock(
* reset is true and this is the only thread on the queue then the
* timeslice counter is reset. The heir THREAD will be updated if the
* running is also the currently the heir.
- *
+ *
* - INTERRUPT LATENCY:
* + ready chain
* + select heir
@@ -157,6 +159,8 @@ void _Scheduler_priority_Unblock(
void _Scheduler_priority_Yield( void );
/**
+ * @brief Scheduler Priority Enqueue
+ *
* This routine puts @a the_thread on to the priority-based ready queue.
*
* @param[in] the_thread will be enqueued at the TAIL of its priority.
@@ -179,7 +183,7 @@ void _Scheduler_priority_Enqueue_first(
);
/**
- * @brief Removes a specific thread from scheduler
+ * @brief Removes a specific thread from scheduler
*
* This routine removes a specific thread from the scheduler's set
* of ready threads.
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index bb8fcb8..502ef8e 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -502,9 +502,9 @@ SCORE_EXTERN Thread_Control *_Thread_Allocated_fp;
* holds a pointer to the task specific data.
*/
SCORE_EXTERN struct _reent **_Thread_libc_reent;
-
-
/**
+ * @brief Initialize Thread Handler
+ *
* This routine performs the initialization necessary for this handler.
*/
void _Thread_Handler_initialization(void);
@@ -524,8 +524,8 @@ void _Thread_Create_idle(void);
* This routine initiates multitasking. It is invoked only as
* part of initialization and its invocation is the last act of
* the non-multitasking part of the system initialization.
- *
- *
+ *
+ *
* - INTERRUPT LATENCY:
* + ready chain
* + select heir
@@ -534,15 +534,15 @@ void _Thread_Start_multitasking( void );
/**
* @brief Dispatch Thread
- *
+ *
* This routine is responsible for transferring control of the
- * processor from the executing thread to the heir thread. Once the
+ * processor from the executing thread to the heir thread. Once the
* heir is running an attempt is made to dispatch any ASRs.
* As part of this process, it is responsible for the following actions:
* + saving the context of the executing thread
* + restoring the context of the heir thread
* + dispatching any signals for the resulting executing thread
-
+
* ALTERNATE ENTRY POINTS:
* void _Thread_Enable_dispatch();
*
@@ -559,7 +559,7 @@ void _Thread_Dispatch( void );
* Set the Start.stack field to the address of the stack.
*
* @param[in] the_thread is the thread where the stack space is requested
- *
+ *
* @retval actual size allocated after any adjustment
* @retval zero if the allocation failed
*/
@@ -570,7 +570,7 @@ size_t _Thread_Stack_Allocate(
/**
* @brief Deallocate Thread Stack
- *
+ *
* Deallocate the Thread's stack.
*/
void _Thread_Stack_Free(
@@ -664,7 +664,7 @@ void _Thread_Close(
* This routine removes any set states for @a the_thread. It performs
* any necessary scheduling operations including the selection of
* a new heir thread.
- *
+ *
* - INTERRUPT LATENCY:
* + ready chain
* + select heir
@@ -679,7 +679,7 @@ void _Thread_Ready(
* This routine clears the indicated STATES for @a the_thread. It performs
* any necessary scheduling operations including the selection of
* a new heir thread.
- *
+ *
* - INTERRUPT LATENCY:
* + priority map
* + select heir
@@ -734,7 +734,7 @@ void _Thread_Handler( void );
/**
* @brief Ended the delay of a Thread
- *
+ *
* This routine is invoked when a thread must be unblocked at the
* end of a time based delay (i.e. wake after or wake when).
* It is called by the watchdog handler.
@@ -748,7 +748,7 @@ void _Thread_Delay_ended(
/**
* @brief Changes the priority of a thread
- *
+ *
* This routine changes the current priority of @a the_thread to
* @a new_priority. It performs any necessary scheduling operations
* including the selection of a new heir thread.
@@ -765,7 +765,7 @@ void _Thread_Change_priority (
/**
* @brief Set Thread Priority
- *
+ *
* This routine updates the priority related fields in the_thread
* control block to indicate the current priority is now new_priority.
*/
@@ -814,7 +814,7 @@ void rtems_iterate_over_all_threads(
/**
* @brief Maps THread Id to a TCB Pointer
- *
+ *
* 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
@@ -823,7 +823,7 @@ void rtems_iterate_over_all_threads(
* to OBJECTS_REMOTE, and the_thread is undefined.
* Otherwise, location is set to OBJECTS_ERROR and
* the_thread is undefined.
- *
+ *
* @param[in] id is the id of the thread.
* @param[in] location is the location of the block.
*
@@ -861,20 +861,18 @@ void _Thread_blocking_operation_Cancel(
Thread_Control *the_thread,
ISR_Level level
);
-
-
#if defined(RTEMS_SMP)
/**
* @brief _Thread_Dispatch_initialization
- *
+ *
* This routine initializes the thread dispatching subsystem.
*/
void _Thread_Dispatch_initialization(void);
/**
* @brief _Thread_Dispatch_in_critical_section
- *
+ *
* This routine returns true if thread dispatch indicates
* that we are in a critical section.
*/
@@ -882,15 +880,15 @@ void _Thread_blocking_operation_Cancel(
/**
* @brief _Thread_Dispatch_get_disable_level
- *
+ *
* This routine returns value of the the thread dispatch level.
*/
uint32_t _Thread_Dispatch_get_disable_level(void);
/**
* @brief _Thread_Dispatch_set_disable_level
- *
- * This routine sets thread dispatch level to the
+ *
+ * This routine sets thread dispatch level to the
* value passed in.
*/
uint32_t _Thread_Dispatch_set_disable_level(uint32_t value);
@@ -904,7 +902,7 @@ void _Thread_blocking_operation_Cancel(
/**
* @brief _Thread_Dispatch_decrement_disable_level
- *
+ *
* This routine decrements the thread dispatch level.
*/
uint32_t _Thread_Dispatch_decrement_disable_level(void);
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index ee7801c..a2653b3 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -88,10 +88,10 @@ Thread_Control *_Thread_queue_Dequeue(
*
* This routine blocks a thread, places it on a thread, and optionally
* starts a timeout timer.
- *
+ *
* @param[in] the_thread_queue pointer to threadq
* @param[in] timeout interval to wait
- *
+ *
* - INTERRUPT LATENCY:
* + single case
*/
@@ -109,7 +109,7 @@ void _Thread_queue_Enqueue_with_handler(
* the_thread is removed from the_thread_queue and reinserted using
* its new priority. This method has no impact on the state of the_thread
* or of any timeouts associated with this blocking.
- *
+ *
* @param[in] the_thread_queue pointer to a threadq header
* @param[in] the_thread pointer to a thread control block
*/
@@ -123,7 +123,7 @@ void _Thread_queue_Requeue(
*
* This routine removes @a the_thread from @a the_thread_queue
* and cancels any timeouts associated with this blocking.
- *
+ *
* @param[in] the_thread_queue is the pointer to the ThreadQ header
* @param[in] the_thread is the pointer to a thread control block that is to be removed
*/
@@ -176,7 +176,7 @@ void _Thread_queue_Flush(
* This routine initializes the_thread_queue based on the
* discipline indicated in attribute_set. The state set on
* threads which block on the_thread_queue is state.
- *
+ *
* @param[in] the_thread_queue is the pointer to a threadq header
* @param[in] discipline is the queueing discipline
* @param[in] state is the state of waiting threads
@@ -199,7 +199,7 @@ void _Thread_queue_Initialize(
* + single case
*
* @param[in] the_thread_queue is a pointer to a thread queue
- *
+ *
* @retval thread dequeued
* @retval NULL if no thread are waiting on the_thread_queue
*/
@@ -216,7 +216,7 @@ Thread_Control *_Thread_queue_Dequeue_priority(
*
* @param[in] the_thread_queue is the pointer to threadq
* @param[in] thread is the thread to insert
- *
+ *
* - INTERRUPT LATENCY:
* + forward less than
* + forward equal
@@ -234,10 +234,10 @@ Thread_blocking_operation_States _Thread_queue_Enqueue_priority (
* and cancels any timeouts associated with this blocking.
* @param[in] the_thread_queue pointer to a threadq header
* @param[in] the_thread pointer to a thread control block
- * @param[in] requeuing true if requeuing and should not alter
+ * @param[in] requeuing true if requeuing and should not alter
* timeout or state
* - INTERRUPT LATENCY:
- * + EXTRACT_PRIORITY
+ * + EXTRACT_PRIORITY
*/
void _Thread_queue_Extract_priority_helper(
Thread_queue_Control *the_thread_queue,
@@ -253,8 +253,6 @@ void _Thread_queue_Extract_priority_helper(
#define _Thread_queue_Extract_priority( _the_thread_queue, _the_thread ) \
_Thread_queue_Extract_priority_helper( _the_thread_queue, _the_thread, false )
-
-
/**
* @brief Returns highest priority thread on the_thread_queue
*
@@ -275,6 +273,14 @@ Thread_Control *_Thread_queue_First_priority(
* This function returns a pointer to the thread which has
* been waiting the longest on the_thread_queue. If no
* threads are waiting on the_thread_queue, then NULL is returned.
+ *
+ * @param[in] the_thread_queue is the pointer to threadq
+ *
+ * @return thread dequeued or NULL
+ *
+ * - INTERRUPT LATENCY:
+ * + check sync
+ * + FIFO
*/
Thread_Control *_Thread_queue_Dequeue_fifo(
Thread_queue_Control *the_thread_queue
@@ -286,11 +292,11 @@ Thread_Control *_Thread_queue_Dequeue_fifo(
* This routine enqueues the currently executing thread on
* the_thread_queue with an optional timeout using the
* FIFO discipline.
- *
+ *
* @param[in] the_thread_queue pointer to threadq
* @param[in] the_thread pointer to the thread to block
* @param[in] level_p interrupt level in case the operation blocks actually
- *
+ *
* - INTERRUPT LATENCY:
* + single case
*/
@@ -317,6 +323,10 @@ void _Thread_queue_Extract_fifo(
* This function returns a pointer to the "first" thread
* on the_thread_queue. The first thread is the thread
* which has been waiting longest on the_thread_queue.
+ *
+ * @param[in] the_thread_queue is the pointer to threadq
+ *
+ * @return first thread or NULL
*/
Thread_Control *_Thread_queue_First_fifo(
Thread_queue_Control *the_thread_queue
@@ -330,7 +340,7 @@ Thread_Control *_Thread_queue_First_fifo(
* enqueue. The task represented by ID will be unblocked and
* its status code will be set in it's control block to indicate
* that a timeout has occurred.
- *
+ *
* @param[in] id thread id
*/
void _Thread_queue_Timeout (
diff --git a/cpukit/score/include/rtems/score/timespec.h b/cpukit/score/include/rtems/score/timespec.h
index 4e0c6e8..41bb8bb 100644
--- a/cpukit/score/include/rtems/score/timespec.h
+++ b/cpukit/score/include/rtems/score/timespec.h
@@ -149,7 +149,7 @@ bool _Timespec_Less_than(
)
/**
- * @brief Add to a Timespec
+ * @brief Add to a Timespec
*
* This routine adds two timespecs. The second argument is added
* to the first.
diff --git a/cpukit/score/include/rtems/score/watchdog.h b/cpukit/score/include/rtems/score/watchdog.h
index a3b0336..1471f84 100644
--- a/cpukit/score/include/rtems/score/watchdog.h
+++ b/cpukit/score/include/rtems/score/watchdog.h
@@ -326,7 +326,7 @@ void _Watchdog_Report_chain(
);
/**
- * @brief Default nanoseconds since last tick handler.
+ * @brief Default Nanoseconds Since Last Tick Handler
*
* @retval 0 Always.
*/
diff --git a/cpukit/score/src/corebarrier.c b/cpukit/score/src/corebarrier.c
index bab4182..5eb620a 100644
--- a/cpukit/score/src/corebarrier.c
+++ b/cpukit/score/src/corebarrier.c
@@ -1,10 +1,11 @@
-/*
- * SuperCore Barrier Handler
- *
- * DESCRIPTION:
- *
- * This package is part of the implementation of the SuperCore Barrier Handler.
+/**
+ * @file
*
+ * @brief Initialize CORE Barrier
+ * @ingroup ScoreBarrier
+ */
+
+/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,19 +24,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
-/*
- * _CORE_barrier_Initialize
- *
- * This function initialize a barrier and sets the initial value based
- * on the given count.
- *
- * Input parameters:
- * the_barrier - the barrier control block to initialize
- * the_barrier_attributes - the attributes specified at create time
- *
- * Output parameters: NONE
- */
-
void _CORE_barrier_Initialize(
CORE_barrier_Control *the_barrier,
CORE_barrier_Attributes *the_barrier_attributes
diff --git a/cpukit/score/src/coremutexseize.c b/cpukit/score/src/coremutexseize.c
index 8394a1d..b6465b2 100644
--- a/cpukit/score/src/coremutexseize.c
+++ b/cpukit/score/src/coremutexseize.c
@@ -1,11 +1,11 @@
-/*
- * Mutex Handler
- *
- * DESCRIPTION:
- *
- * This package is the implementation of the Mutex Handler.
- * This handler provides synchronization and mutual exclusion capabilities.
+/**
+ * @file
*
+ * @brief Seize Mutex with Blocking
+ * @ingroup ScoreMutex
+ */
+
+/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -38,17 +38,6 @@ void _CORE_mutex_Seize(
}
#endif
-/*
- * _CORE_mutex_Seize (interrupt blocking support)
- *
- * This routine blocks the caller thread after an attempt attempts to obtain
- * the specified mutex has failed.
- *
- * Input parameters:
- * the_mutex - pointer to mutex control block
- * timeout - number of ticks to wait (0 means forever)
- */
-
void _CORE_mutex_Seize_interrupt_blocking(
CORE_mutex_Control *the_mutex,
Watchdog_Interval timeout
diff --git a/cpukit/score/src/objectfree.c b/cpukit/score/src/objectfree.c
index f5db746..2e1f657 100644
--- a/cpukit/score/src/objectfree.c
+++ b/cpukit/score/src/objectfree.c
@@ -1,7 +1,11 @@
-/*
- * Object Handler
- *
+/**
+ * @file
*
+ * @brief Free Object
+ * @ingroup ScoreObject
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -26,15 +30,6 @@
#include <rtems/score/sysstate.h>
#include <rtems/score/isr.h>
-/*
- * _Objects_Free
- *
- * DESCRIPTION:
- *
- * This function frees a object control block to the
- * inactive chain of free object control blocks.
- */
-
void _Objects_Free(
Objects_Information *information,
Objects_Control *the_object
diff --git a/cpukit/score/src/scheduleredfallocate.c b/cpukit/score/src/scheduleredfallocate.c
index 5e6ff6a..4982fd4 100644
--- a/cpukit/score/src/scheduleredfallocate.c
+++ b/cpukit/score/src/scheduleredfallocate.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Scheduler EDF Allocate
+ * @ingroup ScoreScheduler
+ */
+
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/scheduleredfupdate.c b/cpukit/score/src/scheduleredfupdate.c
index d79e592..1e1c0ab 100644
--- a/cpukit/score/src/scheduleredfupdate.c
+++ b/cpukit/score/src/scheduleredfupdate.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Scheduler EDF Update
+ * @ingroup ScoreScheduler
+ */
+
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/schedulerpriorityenqueue.c b/cpukit/score/src/schedulerpriorityenqueue.c
index 9829335..89cf4a2 100644
--- a/cpukit/score/src/schedulerpriorityenqueue.c
+++ b/cpukit/score/src/schedulerpriorityenqueue.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Scheduler Priority Enqueue
+ * @ingroup ScoreScheduler
+ */
+
/*
* COPYRIGHT (c) 2011.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/schedulerpriorityfree.c b/cpukit/score/src/schedulerpriorityfree.c
index b882e6a..1f56cb4 100644
--- a/cpukit/score/src/schedulerpriorityfree.c
+++ b/cpukit/score/src/schedulerpriorityfree.c
@@ -1,6 +1,11 @@
-/*
- * Scheduler Handler
+/**
+ * @file
*
+ * @brief Free Scheduler Priority
+ * @ingroup ScoreScheduler
+ */
+
+/*
* Copyright (C) 2010 Gedare Bloom.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/score/src/thread.c b/cpukit/score/src/thread.c
index b598627..b266d6e 100644
--- a/cpukit/score/src/thread.c
+++ b/cpukit/score/src/thread.c
@@ -1,7 +1,11 @@
-/*
- * Thread Handler
- *
+/**
+ * @file
*
+ * @brief Initialize Thread Handler
+ * @ingroup ScoreThread
+ */
+
+/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
@@ -34,16 +38,6 @@
#include <rtems/bspsmp.h>
#endif
-/*
- * _Thread_Handler_initialization
- *
- * This routine initializes all thread manager related data structures.
- *
- * Input parameters: NONE
- *
- * Output parameters: NONE
- */
-
void _Thread_Handler_initialization(void)
{
uint32_t ticks_per_timeslice =
diff --git a/cpukit/score/src/threadqdequeuefifo.c b/cpukit/score/src/threadqdequeuefifo.c
index 119c2d6..fcad820 100644
--- a/cpukit/score/src/threadqdequeuefifo.c
+++ b/cpukit/score/src/threadqdequeuefifo.c
@@ -1,7 +1,11 @@
-/*
- * Thread Queue Handler
- *
+/**
+ * @file
*
+ * @brief Thread Queue Dequeue FIFO
+ * @ingroup ScoreThreadQ
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,22 +27,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
-/*
- * _Thread_queue_Dequeue_fifo
- *
- * This routine removes a thread from the specified threadq.
- *
- * Input parameters:
- * the_thread_queue - pointer to threadq
- *
- * Output parameters:
- * returns - thread dequeued or NULL
- *
- * INTERRUPT LATENCY:
- * check sync
- * FIFO
- */
-
Thread_Control *_Thread_queue_Dequeue_fifo(
Thread_queue_Control *the_thread_queue
)
diff --git a/cpukit/score/src/threadqfirstfifo.c b/cpukit/score/src/threadqfirstfifo.c
index 6bf362f..c22debd 100644
--- a/cpukit/score/src/threadqfirstfifo.c
+++ b/cpukit/score/src/threadqfirstfifo.c
@@ -1,7 +1,11 @@
-/*
- * Thread Queue Handler
- *
+/**
+ * @file
*
+ * @brief Thread Queue First FIFO
+ * @ingroup ScoreThreadQ
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,19 +27,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
-/*
- * _Thread_queue_First_fifo
- *
- * This routines returns a pointer to the first thread on the
- * specified threadq.
- *
- * Input parameters:
- * the_thread_queue - pointer to threadq
- *
- * Output parameters:
- * returns - first thread or NULL
- */
-
Thread_Control *_Thread_queue_First_fifo(
Thread_queue_Control *the_thread_queue
)
diff --git a/cpukit/score/src/timespecaddto.c b/cpukit/score/src/timespecaddto.c
index 4d14cab..a71e1d6 100644
--- a/cpukit/score/src/timespecaddto.c
+++ b/cpukit/score/src/timespecaddto.c
@@ -1,5 +1,8 @@
/**
- * @file score/src/timespecaddto.c
+ * @file
+ *
+ * @brief Add to a Timespec
+ * @ingroup Timespec
*/
/*
@@ -21,12 +24,6 @@
#include <rtems/score/tod.h>
#include <rtems/score/watchdog.h>
-/**
- *
- * This routines adds two timespecs. The second argument is added
- * to the first.
- */
-
uint32_t _Timespec_Add_to(
struct timespec *time,
const struct timespec *add
diff --git a/cpukit/score/src/watchdognanoseconds.c b/cpukit/score/src/watchdognanoseconds.c
index 37b56b4..41353bc 100644
--- a/cpukit/score/src/watchdognanoseconds.c
+++ b/cpukit/score/src/watchdognanoseconds.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Default Nanoseconds Since Last Tick Handler
+ * @ingroup ScoreWatchdog
+ */
+
/*
* Copyright (c) 2010 embedded brains GmbH. All rights reserved.
*
More information about the vc
mailing list