RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

score misc: Score misc: Clean up Doxygen #5

Browse Source
This commit is contained in:
Alex Ivanov
2012-11-29 12:39:19 -06:00
committed by Joel Sherrill
parent db650357f0
commit e655f7e4fa
30 changed files with 201 additions and 230 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
cpukit/Doxyfile.in
View File

@@ -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.

4
cpukit/score/include/rtems/bspsmp.h
View File

@@ -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.
*/

24
cpukit/score/include/rtems/score/coremsg.h
View File

@@ -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,

7
cpukit/score/include/rtems/score/coresem.h
View File

@@ -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.
*

2
cpukit/score/include/rtems/score/object.h
View File

@@ -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.

4
cpukit/score/include/rtems/score/schedulercbs.h
View File

@@ -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.

6
cpukit/score/include/rtems/score/schedulerpriority.h
View File

@@ -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 );

17
cpukit/score/include/rtems/score/thread.h
View File

@@ -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,

6
cpukit/score/include/rtems/score/threadmp.h
View File

@@ -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.

2
cpukit/score/include/rtems/score/timespec.h
View File

@@ -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.
*

35
cpukit/score/src/coremsgbroadcast.c
View File

@@ -1,12 +1,11 @@
/**
* @file
*
* @brief Broadcast a Message to the Message Queue
* @ingroup ScoreMessageQueue
*/
/*
* 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.
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,26 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/wkspace.h>
/*
* _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,

29
cpukit/score/src/coremsgclose.c
View File

@@ -1,12 +1,11 @@
/**
* @file
*
* @brief Close a Message Queue
* @ingroup ScoreMessageQueue
*/
/*
* 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.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,20 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/wkspace.h>
/*
* _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,

28
cpukit/score/src/coremsgflush.c
View File

@@ -1,12 +1,11 @@
/**
* @file
*
* @brief Flush Pending Messages
* @ingroup ScoreMessageQueue
*/
/*
* 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.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,19 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/wkspace.h>
/*
* _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
)

40
cpukit/score/src/coremsgseize.c
View File

@@ -1,12 +1,11 @@
/**
* @file
*
* @brief Size a Message from the Message Queue
* @ingroup ScoreMessageQueue
*/
/*
* 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.
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,31 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/wkspace.h>
/*
* _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,

28
cpukit/score/src/coresemflush.c
View File

@@ -1,12 +1,11 @@
/**
* @file
*
* @brief Core Semaphore Flush
* @ingroup ScoreSemaphore
*/
/*
* 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.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -26,19 +25,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
/*
* _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,

14
cpukit/score/src/isrsmp.c
View File

@@ -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;

7
cpukit/score/src/objectgetinfo.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Get Object Information
* @ingroup ScoreObject
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).

7
cpukit/score/src/schedulercbsattachthread.c
View File

@@ -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).

7
cpukit/score/src/schedulercbsgetserverid.c
View File

@@ -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).

7
cpukit/score/src/scheduleredfschedule.c
View File

@@ -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).

15
cpukit/score/src/schedulerpriorityyield.c
View File

@@ -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 <rtems/score/schedulerpriority.h>
#include <rtems/score/thread.h>
/*
* INTERRUPT LATENCY:
* ready chain
* select heir
*/
void _Scheduler_priority_Yield(void)
{
Scheduler_priority_Per_thread *sched_info;

7
cpukit/score/src/schedulersimplesmptick.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Scheduler Simple SMP Tick Method
* @ingroup ScoreScheduler
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).

27
cpukit/score/src/smp.c
View File

@@ -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;

14
cpukit/score/src/threadclearstate.c
View File

@@ -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 <rtems/score/threadq.h>
#include <rtems/score/wkspace.h>
/*
* INTERRUPT LATENCY:
* priority map
* select heir
*/
void _Thread_Clear_state(
Thread_Control *the_thread,
States_Control state

10
cpukit/score/src/threadcreateidle.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Create Idle Thread
* @ingroup ScoreThread
*/
/*
* Thread Handler
*
*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*

25
cpukit/score/src/threadmp.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Distributed MP Support
* @ingroup ScoreThreadMP
*/
/*
* Multiprocessing Support for the Thread Handler
*
*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,11 +25,6 @@
#include <rtems/score/wkspace.h>
#include <rtems/score/isr.h>
/*
* _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

16
cpukit/score/src/threadstackfree.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Deallocate Thread Stack
* @ingroup ScoreThread
*/
/*
* Thread Handler
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,12 +32,6 @@
#include <rtems/score/wkspace.h>
#include <rtems/config.h>
/*
* _Thread_Stack_Free
*
* Deallocate the Thread's stack.
*/
void _Thread_Stack_Free(
Thread_Control *the_thread
)

30
cpukit/score/src/threadstartmultitasking.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Start Thread Multitasking
* @ingroup ScoreThread
*/
/*
* Thread Handler
*
*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -27,26 +31,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/wkspace.h>
/*
* _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 )
{
/*

5
cpukit/score/src/timespeclessthan.c
View File

@@ -1,5 +1,8 @@
/**
* @file score/src/timespeclessthan.c
* @file
*
* @brief Timespec Less Than Operator
* @ingroup Timespec
*/
/*

5
cpukit/score/src/watchdogreportchain.c
View File

@@ -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.