From e655f7e4fae3e7f5f0b5738457c9d09d3cd6b773 Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Thu, 29 Nov 2012 12:39:19 -0600 Subject: score misc: Score misc: Clean up Doxygen #5 --- cpukit/Doxyfile.in | 3 +- cpukit/score/include/rtems/bspsmp.h | 4 +++ cpukit/score/include/rtems/score/coremsg.h | 24 +++++++++++++ cpukit/score/include/rtems/score/coresem.h | 7 ++++ cpukit/score/include/rtems/score/object.h | 2 ++ cpukit/score/include/rtems/score/schedulercbs.h | 4 +-- .../score/include/rtems/score/schedulerpriority.h | 6 ++++ cpukit/score/include/rtems/score/thread.h | 17 +++++++++ cpukit/score/include/rtems/score/threadmp.h | 6 ++-- cpukit/score/include/rtems/score/timespec.h | 2 +- cpukit/score/src/coremsgbroadcast.c | 35 ++++--------------- cpukit/score/src/coremsgclose.c | 29 ++++------------ cpukit/score/src/coremsgflush.c | 28 ++++----------- cpukit/score/src/coremsgseize.c | 40 ++++------------------ cpukit/score/src/coresemflush.c | 28 ++++----------- cpukit/score/src/isrsmp.c | 14 ++++---- cpukit/score/src/objectgetinfo.c | 7 ++++ cpukit/score/src/schedulercbsattachthread.c | 7 ++++ cpukit/score/src/schedulercbsgetserverid.c | 7 ++++ cpukit/score/src/scheduleredfschedule.c | 7 ++++ cpukit/score/src/schedulerpriorityyield.c | 15 ++++---- cpukit/score/src/schedulersimplesmptick.c | 7 ++++ cpukit/score/src/smp.c | 27 ++++----------- cpukit/score/src/threadclearstate.c | 14 ++++---- cpukit/score/src/threadcreateidle.c | 10 ++++-- cpukit/score/src/threadmp.c | 25 ++++---------- cpukit/score/src/threadstackfree.c | 16 ++++----- cpukit/score/src/threadstartmultitasking.c | 30 ++++------------ cpukit/score/src/timespeclessthan.c | 5 ++- cpukit/score/src/watchdogreportchain.c | 5 +-- 30 files changed, 201 insertions(+), 230 deletions(-) diff --git a/cpukit/Doxyfile.in b/cpukit/Doxyfile.in index c33b2be870..4a6ee55957 100644 --- a/cpukit/Doxyfile.in +++ b/cpukit/Doxyfile.in @@ -592,7 +592,8 @@ INPUT_ENCODING = UTF-8 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.h \ - *.inl + *.inl \ + *.c # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. diff --git a/cpukit/score/include/rtems/bspsmp.h b/cpukit/score/include/rtems/bspsmp.h index 05dc9d16b8..9c040efeda 100644 --- a/cpukit/score/include/rtems/bspsmp.h +++ b/cpukit/score/include/rtems/bspsmp.h @@ -143,6 +143,8 @@ int bsp_smp_processor_id( void ); void bsp_smp_secondary_cpu_initialize(int cpu); /** + * @brief RTEMS SMP Secondary CPU Initialize + * * This method is the C entry point which secondary CPUs should * arrange to call. It performs OS initialization for the secondary * CPU and coordinates bring it to a useful state. @@ -162,6 +164,8 @@ void rtems_smp_secondary_cpu_initialize(void); void rtems_smp_initialize_per_cpu(int cpu); /** + * @brief RTEMS SMP Proccess Interrupt + * * This is the method called by the BSP's interrupt handler * to process the incoming interprocessor request. */ diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h index c864685689..fccebbf57c 100644 --- a/cpukit/score/include/rtems/score/coremsg.h +++ b/cpukit/score/include/rtems/score/coremsg.h @@ -288,6 +288,11 @@ bool _CORE_message_queue_Initialize( /** * @brief Close a Message Queue + * + * DESCRIPTION: + * This package is the implementation of the CORE Message Queue Handler. + * This core object provides task synchronization and communication functions + * via messages passed to queue objects * * This function closes a message by returning all allocated space and * flushing @a the_message_queue's task wait queue. @@ -306,6 +311,11 @@ void _CORE_message_queue_Close( /** * @brief Flush Pending Messages + * + * DESCRIPTION: + * This package is the implementation of the CORE Message Queue Handler. + * This core object provides task synchronization and communication functions + * via messages passed to queue objects. * * This function flushes @a the_message_queue's pending message queue. The * number of messages flushed from the queue is returned. @@ -349,6 +359,11 @@ uint32_t _CORE_message_queue_Flush_support( /** * @brief Broadcast a Message to the Message Queue + * + * DESCRIPTION: + * This package is the implementation of the CORE Message Queue Handler. + * This core object provides task synchronization and communication functions + * via messages passed to queue objects. * * This function sends a message for every thread waiting on the queue and * returns the number of threads made ready by the message. @@ -412,6 +427,11 @@ CORE_message_queue_Status _CORE_message_queue_Submit( /** * @brief Size a Message from the Message Queue + * + * DESCRIPTION: + * This package is the implementation of the CORE Message Queue Handler. + * This core object provides task synchronization and communication functions + * via messages passed to queue objects. * * This kernel routine dequeues a message, copies the message buffer to * a given destination buffer, and frees the message buffer to the @@ -432,6 +452,10 @@ CORE_message_queue_Status _CORE_message_queue_Submit( * * @return indication of the successful completion or reason for failure * @note Returns message priority via return are in TCB. + * + * - INTERRUPT LATENCY: + * + available + * + wait */ void _CORE_message_queue_Seize( CORE_message_queue_Control *the_message_queue, diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h index c8d7deb703..243d0093a2 100644 --- a/cpukit/score/include/rtems/score/coresem.h +++ b/cpukit/score/include/rtems/score/coresem.h @@ -189,6 +189,13 @@ CORE_semaphore_Status _CORE_semaphore_Surrender( ); /** + * @brief Core Semaphore Flush + * + * DESCRIPTION: + * This package is the implementation of the CORE Semaphore Handler. + * This core object utilizes standard Dijkstra counting semaphores to provide + * synchronization and mutual exclusion capabilities. + * * This routine assists in the deletion of a semaphore by flushing the * associated wait queue. * diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index 1dec9930d1..56dedd9812 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -752,6 +752,8 @@ Objects_Control *_Objects_Get_next( ); /** + * @brief Get Object Information + * * This function return the information structure given * an the API and Class. This can be done independent of * the existence of any objects created by the API. diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h index a70f55b27b..1751ad13f9 100644 --- a/cpukit/score/include/rtems/score/schedulercbs.h +++ b/cpukit/score/include/rtems/score/schedulercbs.h @@ -175,7 +175,7 @@ void _Scheduler_CBS_Release_job ( int _Scheduler_CBS_Initialize(void); /** - * @brief _Scheduler_CBS_Attach_thread + * @brief Attach Scheduler CBS Thread * * Attach a task to an already existing server. * @@ -284,7 +284,7 @@ int _Scheduler_CBS_Get_parameters ( ); /** - * @brief _Scheduler_CBS_Get_server_id + * @brief Scheduler CBS Get Server id * * Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not * attached to any server. diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h index 844d043eb4..0e4d52eec5 100644 --- a/cpukit/score/include/rtems/score/schedulerpriority.h +++ b/cpukit/score/include/rtems/score/schedulerpriority.h @@ -136,6 +136,8 @@ void _Scheduler_priority_Unblock( ); /** + * @brief Scheduler Priority Yield + * * This routine is invoked when a thread wishes to voluntarily * transfer control of the processor to another thread in the queue. * @@ -145,6 +147,10 @@ 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 */ void _Scheduler_priority_Yield( void ); diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h index 1c8723f70a..966867a1d3 100644 --- a/cpukit/score/include/rtems/score/thread.h +++ b/cpukit/score/include/rtems/score/thread.h @@ -510,6 +510,8 @@ SCORE_EXTERN struct _reent **_Thread_libc_reent; void _Thread_Handler_initialization(void); /** + * @brief Create Idle Thread + * * This routine creates the idle thread. * * @warning No thread should be created before this one. @@ -517,9 +519,16 @@ void _Thread_Handler_initialization(void); void _Thread_Create_idle(void); /** + * @brief Start Thread Multitasking + * * 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 */ void _Thread_Start_multitasking( void ); @@ -560,6 +569,8 @@ size_t _Thread_Stack_Allocate( ); /** + * @brief Deallocate Thread Stack + * * Deallocate the Thread's stack. */ void _Thread_Stack_Free( @@ -655,9 +666,15 @@ void _Thread_Ready( ); /** + * @brief Clear Thread state + * * 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 */ void _Thread_Clear_state( Thread_Control *the_thread, diff --git a/cpukit/score/include/rtems/score/threadmp.h b/cpukit/score/include/rtems/score/threadmp.h index 4814098b70..eba713ca57 100644 --- a/cpukit/score/include/rtems/score/threadmp.h +++ b/cpukit/score/include/rtems/score/threadmp.h @@ -32,7 +32,7 @@ extern "C" { #endif /** - * @brief _Thread_MP_Handler_initialization + * @brief MP Thread Handler Initialization * * This routine initializes the multiprocessing portion of the Thread Handler. */ @@ -41,7 +41,7 @@ void _Thread_MP_Handler_initialization ( ); /** - * @brief _Thread_MP_Allocate_proxy + * @brief MP Thread Proxy Allocate * * This allocates a proxy control block from * the inactive chain of free proxy control blocks. @@ -54,7 +54,7 @@ Thread_Control *_Thread_MP_Allocate_proxy ( ); /** - * @brief _Thread_MP_Find_proxy + * @brief MP Thread Proxy Find * * This function removes the proxy control block for the specified * id from the active chain of proxy control blocks. diff --git a/cpukit/score/include/rtems/score/timespec.h b/cpukit/score/include/rtems/score/timespec.h index 39394ff3da..4e0c6e8e1c 100644 --- a/cpukit/score/include/rtems/score/timespec.h +++ b/cpukit/score/include/rtems/score/timespec.h @@ -103,7 +103,7 @@ bool _Timespec_Is_valid( ); /** - * @brief Timespec Less Than Operator + * @brief Timespec Less Than Operator * * This method is the less than operator for timespecs. * diff --git a/cpukit/score/src/coremsgbroadcast.c b/cpukit/score/src/coremsgbroadcast.c index d5d1f95563..7cee3e8fce 100644 --- a/cpukit/score/src/coremsgbroadcast.c +++ b/cpukit/score/src/coremsgbroadcast.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. +/** + * @file * + * @brief Broadcast a Message to the Message Queue + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -28,26 +27,6 @@ #include #include -/* - * _CORE_message_queue_Broadcast - * - * This function sends a message for every thread waiting on the queue and - * returns the number of threads made ready by the message. - * - * Input parameters: - * the_message_queue - message is submitted to this message queue - * buffer - pointer to message buffer - * size - size in bytes of message to send - * id - id of message queue - * api_message_queue_mp_support - api specific mp support callout - * count - area to store number of threads made ready - * - * Output parameters: - * count - number of threads made ready - * CORE_MESSAGE_QUEUE_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - CORE_message_queue_Status _CORE_message_queue_Broadcast( CORE_message_queue_Control *the_message_queue, const void *buffer, diff --git a/cpukit/score/src/coremsgclose.c b/cpukit/score/src/coremsgclose.c index 930c0adea9..38b0183fb0 100644 --- a/cpukit/score/src/coremsgclose.c +++ b/cpukit/score/src/coremsgclose.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. +/** + * @file * + * @brief Close a Message Queue + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -28,20 +27,6 @@ #include #include -/* - * _CORE_message_queue_Close - * - * This function closes a message by returning all allocated space and - * flushing the message_queue's task wait queue. - * - * Input parameters: - * the_message_queue - the message_queue to be flushed - * remote_extract_callout - function to invoke remotely - * status - status to pass to thread - * - * Output parameters: NONE - */ - void _CORE_message_queue_Close( CORE_message_queue_Control *the_message_queue, Thread_queue_Flush_callout remote_extract_callout, diff --git a/cpukit/score/src/coremsgflush.c b/cpukit/score/src/coremsgflush.c index 0faf6c3c26..0681cbb0b7 100644 --- a/cpukit/score/src/coremsgflush.c +++ b/cpukit/score/src/coremsgflush.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. +/** + * @file * + * @brief Flush Pending Messages + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -28,19 +27,6 @@ #include #include -/* - * _CORE_message_queue_Flush - * - * This function flushes the message_queue's pending message queue. The - * number of messages flushed from the queue is returned. - * - * Input parameters: - * the_message_queue - the message_queue to be flushed - * - * Output parameters: - * returns - the number of messages flushed from the queue - */ - uint32_t _CORE_message_queue_Flush( CORE_message_queue_Control *the_message_queue ) diff --git a/cpukit/score/src/coremsgseize.c b/cpukit/score/src/coremsgseize.c index 84652d1b77..bb49810bbd 100644 --- a/cpukit/score/src/coremsgseize.c +++ b/cpukit/score/src/coremsgseize.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. +/** + * @file * + * @brief Size a Message from the Message Queue + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -28,31 +27,6 @@ #include #include -/* - * _CORE_message_queue_Seize - * - * This kernel routine dequeues a message, copies the message buffer to - * a given destination buffer, and frees the message buffer to the - * inactive message pool. The thread will be blocked if wait is true, - * otherwise an error will be given to the thread if no messages are available. - * - * Input parameters: - * the_message_queue - pointer to message queue - * id - id of object we are waitig on - * buffer - pointer to message buffer to be filled - * size_p - pointer to the size of buffer to be filled - * wait - true if wait is allowed, false otherwise - * timeout - time to wait for a message - * - * Output parameters: NONE - * - * NOTE: Dependent on BUFFER_LENGTH - * - * INTERRUPT LATENCY: - * available - * wait - */ - void _CORE_message_queue_Seize( CORE_message_queue_Control *the_message_queue, Objects_Id id, diff --git a/cpukit/score/src/coresemflush.c b/cpukit/score/src/coresemflush.c index 5958159138..f0f819de2b 100644 --- a/cpukit/score/src/coresemflush.c +++ b/cpukit/score/src/coresemflush.c @@ -1,12 +1,11 @@ -/* - * CORE Semaphore Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Semaphore Handler. - * This core object utilizes standard Dijkstra counting semaphores to provide - * synchronization and mutual exclusion capabilities. +/** + * @file * + * @brief Core Semaphore Flush + * @ingroup ScoreSemaphore + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -26,19 +25,6 @@ #include #include -/* - * _CORE_semaphore_Flush - * - * This function a flushes the semaphore's task wait queue. - * - * Input parameters: - * the_semaphore - the semaphore to be flushed - * remote_extract_callout - function to invoke remotely - * status - status to pass to thread - * - * Output parameters: NONE - */ - void _CORE_semaphore_Flush( CORE_semaphore_Control *the_semaphore, Thread_queue_Flush_callout remote_extract_callout, diff --git a/cpukit/score/src/isrsmp.c b/cpukit/score/src/isrsmp.c index e9504b502a..7fb3f75bc3 100644 --- a/cpukit/score/src/isrsmp.c +++ b/cpukit/score/src/isrsmp.c @@ -1,6 +1,11 @@ -/* - * ISR Enable/Disable for SMP Configurations +/** + * @file * + * @brief Initialize, Disable, Enable, Flash, Enter, Exit ISR Implementation + * @ingroup ScoreISR + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -57,11 +62,6 @@ int _ISR_SMP_Enter(void) return isr_nest_level; } -/* - * Return values: - * 0 - simple return - * 1 - dispatching return - */ int _ISR_SMP_Exit(void) { ISR_Level level; diff --git a/cpukit/score/src/objectgetinfo.c b/cpukit/score/src/objectgetinfo.c index 416726343f..3955acc3ca 100644 --- a/cpukit/score/src/objectgetinfo.c +++ b/cpukit/score/src/objectgetinfo.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get Object Information + * @ingroup ScoreObject + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulercbsattachthread.c b/cpukit/score/src/schedulercbsattachthread.c index 9641cc57e5..56602a22d1 100644 --- a/cpukit/score/src/schedulercbsattachthread.c +++ b/cpukit/score/src/schedulercbsattachthread.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Attach Scheduler CBS Thread + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulercbsgetserverid.c b/cpukit/score/src/schedulercbsgetserverid.c index 5147621e4d..e0f35779f6 100644 --- a/cpukit/score/src/schedulercbsgetserverid.c +++ b/cpukit/score/src/schedulercbsgetserverid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Scheduler CBS Get Server id + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/scheduleredfschedule.c b/cpukit/score/src/scheduleredfschedule.c index a45aca41d3..dbe21dc491 100644 --- a/cpukit/score/src/scheduleredfschedule.c +++ b/cpukit/score/src/scheduleredfschedule.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Scheduler EDF Allocate + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011-2012 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulerpriorityyield.c b/cpukit/score/src/schedulerpriorityyield.c index 62c3807982..c000125daf 100644 --- a/cpukit/score/src/schedulerpriorityyield.c +++ b/cpukit/score/src/schedulerpriorityyield.c @@ -1,6 +1,11 @@ -/* - * Scheduler Priority Handler / Yield +/** + * @file * + * @brief Scheduler Priority Yield + * @ingroup ScoreScheduler + */ + +/* * Copyright (C) 2010 Gedare Bloom. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). * @@ -19,12 +24,6 @@ #include #include -/* - * INTERRUPT LATENCY: - * ready chain - * select heir - */ - void _Scheduler_priority_Yield(void) { Scheduler_priority_Per_thread *sched_info; diff --git a/cpukit/score/src/schedulersimplesmptick.c b/cpukit/score/src/schedulersimplesmptick.c index 3be87db846..72f8b1f761 100644 --- a/cpukit/score/src/schedulersimplesmptick.c +++ b/cpukit/score/src/schedulersimplesmptick.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Scheduler Simple SMP Tick Method + * @ingroup ScoreScheduler + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/smp.c b/cpukit/score/src/smp.c index f0b576ee8c..cd4d2350ba 100644 --- a/cpukit/score/src/smp.c +++ b/cpukit/score/src/smp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief SMP Support + * @ingroup Score + */ + /* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). @@ -42,9 +49,6 @@ void rtems_smp_run_first_task(int cpu) _CPU_Context_switch_to_first_task_smp( &heir->Registers ); } -/* - * Process request to initialize this secondary core. - */ void rtems_smp_secondary_cpu_initialize(void) { int cpu; @@ -90,10 +94,6 @@ void rtems_smp_secondary_cpu_initialize(void) } } -/* - * Process an interrupt processor interrupt which indicates a request - * from another core. - */ void rtems_smp_process_interrupt(void) { int cpu; @@ -179,9 +179,6 @@ void _SMP_Send_message( bsp_smp_interrupt_cpu( cpu ); } -/* - * Send interrupt processor request to all other nodes - */ void _SMP_Broadcast_message( uint32_t message ) @@ -202,9 +199,6 @@ void _SMP_Broadcast_message( bsp_smp_broadcast_interrupt(); } -/* - * Send interrupt processor requests to perform first context switch - */ void _SMP_Request_other_cores_to_perform_first_context_switch(void) { int cpu; @@ -215,10 +209,6 @@ void _SMP_Request_other_cores_to_perform_first_context_switch(void) } } -/* - * Send message to other cores requesting them to perform - * a thread dispatch operation. - */ void _SMP_Request_other_cores_to_dispatch(void) { int i; @@ -239,9 +229,6 @@ void _SMP_Request_other_cores_to_dispatch(void) } } -/* - * Send message to other cores requesting them to shutdown. - */ void _SMP_Request_other_cores_to_shutdown(void) { bool allDown; diff --git a/cpukit/score/src/threadclearstate.c b/cpukit/score/src/threadclearstate.c index 492f5336fc..cf59f3b561 100644 --- a/cpukit/score/src/threadclearstate.c +++ b/cpukit/score/src/threadclearstate.c @@ -1,6 +1,11 @@ -/* - * Thread Handler / Thread Clear State +/** + * @file * + * @brief Clear Thread state + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -27,11 +32,6 @@ #include #include -/* - * INTERRUPT LATENCY: - * priority map - * select heir - */ void _Thread_Clear_state( Thread_Control *the_thread, States_Control state diff --git a/cpukit/score/src/threadcreateidle.c b/cpukit/score/src/threadcreateidle.c index 1f10065e5b..a0279dec49 100644 --- a/cpukit/score/src/threadcreateidle.c +++ b/cpukit/score/src/threadcreateidle.c @@ -1,7 +1,11 @@ -/* - * Thread Handler - * +/** + * @file * + * @brief Create Idle Thread + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/score/src/threadmp.c b/cpukit/score/src/threadmp.c index 426d68684f..9b85873f7d 100644 --- a/cpukit/score/src/threadmp.c +++ b/cpukit/score/src/threadmp.c @@ -1,7 +1,11 @@ -/* - * Multiprocessing Support for the Thread Handler - * +/** + * @file * + * @brief Distributed MP Support + * @ingroup ScoreThreadMP + */ + +/* * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * @@ -21,11 +25,6 @@ #include #include -/* - * _Thread_MP_Handler_initialization - * - */ - void _Thread_MP_Handler_initialization ( uint32_t maximum_proxies ) @@ -50,11 +49,6 @@ void _Thread_MP_Handler_initialization ( } -/* - * _Thread_MP_Allocate_proxy - * - */ - Thread_Control *_Thread_MP_Allocate_proxy ( States_Control the_state ) @@ -100,11 +94,6 @@ Thread_Control *_Thread_MP_Allocate_proxy ( return NULL; } -/* - * _Thread_MP_Find_proxy - * - */ - /* * The following macro provides the offset of the Active element * in the Thread_Proxy_control structure. This is the logical diff --git a/cpukit/score/src/threadstackfree.c b/cpukit/score/src/threadstackfree.c index 1c20bad349..8a441009ec 100644 --- a/cpukit/score/src/threadstackfree.c +++ b/cpukit/score/src/threadstackfree.c @@ -1,7 +1,11 @@ -/* - * Thread Handler - * +/** + * @file * + * @brief Deallocate Thread Stack + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -28,12 +32,6 @@ #include #include -/* - * _Thread_Stack_Free - * - * Deallocate the Thread's stack. - */ - void _Thread_Stack_Free( Thread_Control *the_thread ) diff --git a/cpukit/score/src/threadstartmultitasking.c b/cpukit/score/src/threadstartmultitasking.c index acc5b26f75..32a594bd3b 100644 --- a/cpukit/score/src/threadstartmultitasking.c +++ b/cpukit/score/src/threadstartmultitasking.c @@ -1,7 +1,11 @@ -/* - * Thread Handler - * +/** + * @file * + * @brief Start Thread Multitasking + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * @@ -27,26 +31,6 @@ #include #include -/* - * _Thread_Start_multitasking - * - * This kernel routine readies the requested thread, the thread chain - * is adjusted. A new heir thread may be selected. - * - * Input parameters: - * system_thread - pointer to system initialization thread control block - * idle_thread - pointer to idle thread control block - * - * Output parameters: NONE - * - * NOTE: This routine uses the "blocking" heir selection mechanism. - * This ensures the correct heir after a thread restart. - * - * INTERRUPT LATENCY: - * ready chain - * select heir - */ - void _Thread_Start_multitasking( void ) { /* diff --git a/cpukit/score/src/timespeclessthan.c b/cpukit/score/src/timespeclessthan.c index fedf83cba3..c120ae97b6 100644 --- a/cpukit/score/src/timespeclessthan.c +++ b/cpukit/score/src/timespeclessthan.c @@ -1,5 +1,8 @@ /** - * @file score/src/timespeclessthan.c + * @file + * + * @brief Timespec Less Than Operator + * @ingroup Timespec */ /* diff --git a/cpukit/score/src/watchdogreportchain.c b/cpukit/score/src/watchdogreportchain.c index aeea191cf5..ea6c2f7415 100644 --- a/cpukit/score/src/watchdogreportchain.c +++ b/cpukit/score/src/watchdogreportchain.c @@ -1,7 +1,8 @@ /** - * @file watchdogreportchain.c + * @file * - * This should only be used for debugging. + * @brief Report Information on a Watchdog Chain + * @ingroup ScoreWatchdog */ /* COPYRIGHT (c) 1989-2008. -- cgit v1.2.3