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

rtems: Doxygen Clean Up Task #2

Browse Source
This commit is contained in:
Ayush Awasthi
2013-01-04 09:22:20 -06:00
committed by Jennifer Averett
parent 00c1cd5f60
commit d106ab3efd
20 changed files with 686 additions and 612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
cpukit/rtems/include/rtems/rtems/asr.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/asr.h
*
* @brief Constants and Structures Associated with the Asynchronous Signal Handler
* @defgroup ClassicASR ASR Support
*
* @ingroup ClassicRTEMS
* @brief Asynchronous Signal Handler
*
* This include file contains all the constants and structures associated
* with the Asynchronous Signal Handler. This Handler provides the low-level

17
cpukit/rtems/include/rtems/rtems/barrier.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/barrier.h
*
* @brief Constants and Structures Associated with the Barrier Manager
* @defgroup ClassicBarrier Barriers
*
* @ingroup ClassicRTEMS
* @brief Classic API Barrier Manager
*
* This include file contains all the constants and structures associated
* with the Barrier Manager.
@@ -103,7 +106,7 @@ void _Barrier_Manager_initialization(void);
* be allowed to concurrently wait at the barrier.
* @param[out] id will contain the id of this barrier.
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code rtems_barrier_create(
rtems_name name,
@@ -126,7 +129,7 @@ rtems_status_code rtems_barrier_create(
* @param[in] name is the name of this barrier instance.
* @param[out] id will contain the id of this barrier.
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code rtems_barrier_ident(
rtems_name name,
@@ -143,7 +146,7 @@ rtems_status_code rtems_barrier_ident(
*
* @param[in] id indicates the barrier to delete
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code rtems_barrier_delete(
rtems_id id
@@ -161,7 +164,7 @@ rtems_status_code rtems_barrier_delete(
* @param[in] timeout is the maximum length of time in ticks the calling
* thread is willing to block.
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code rtems_barrier_wait(
rtems_id id,
@@ -181,7 +184,7 @@ rtems_status_code rtems_barrier_wait(
* @param[in] id indicates the barrier to wait at.
* @param[out] released will contain the number of threads unblocked.
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code rtems_barrier_release(
rtems_id id,
@@ -196,7 +199,7 @@ rtems_status_code rtems_barrier_release(
*
* @param[in] the_status is the SuperCore Barrier status to translate.
*
* @return a status code indicating success or the reason for failure.
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code _Barrier_Translate_core_barrier_return_code (
CORE_barrier_Status the_status

29
cpukit/rtems/include/rtems/rtems/clock.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/clock.h
*
* @brief Constants and Structures Associated with the Clock Manager
* @defgroup ClassicClock Clocks
*
* @ingroup ClassicRTEMS
* @brief Clock Manager API
*
* This include file contains all the constants and structures associated
* with the Clock Manager. This manager provides facilities to set, obtain,
@@ -82,7 +85,7 @@ typedef Watchdog_Nanoseconds_since_last_tick_routine
* @param[in] option is the format of time to return
* @param[in] time_buffer points to the output area
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -101,7 +104,7 @@ rtems_status_code rtems_clock_get(
*
* @param[in] time_buffer points to the time of day structure
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the time_buffer will
* be filled in with the current time of day.
@@ -118,7 +121,7 @@ rtems_status_code rtems_clock_get_tod(
*
* @param[in] time points to the struct timeval variable to fill in
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the time will
* be filled in with the current time of day.
@@ -135,7 +138,7 @@ rtems_status_code rtems_clock_get_tod_timeval(
*
* @param[in] the_interval points to the interval variable to fill in
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the time_buffer will
* be filled in with the current time of day.
@@ -150,7 +153,7 @@ rtems_status_code rtems_clock_get_seconds_since_epoch(
* This routine implements the rtems_clock_get_ticks_since_boot
* directive.
*
* @return This method returns the number of ticks since boot. It cannot
* @retval This method returns the number of ticks since boot. It cannot
* fail since RTEMS always keeps a running count of ticks since boot.
*/
rtems_interval rtems_clock_get_ticks_since_boot(void);
@@ -161,7 +164,7 @@ rtems_interval rtems_clock_get_ticks_since_boot(void);
* This routine implements the rtems_clock_get_ticks_per_second
* directive.
*
* @return This method returns the number of ticks since boot. It cannot
* @retval This method returns the number of ticks since boot. It cannot
* fail since RTEMS is always configured to know the number of
* ticks per second.
*/
@@ -175,7 +178,7 @@ rtems_interval rtems_clock_get_ticks_per_second(void);
*
* @param[in] time_buffer points to the new TOD
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*
@@ -192,7 +195,7 @@ rtems_status_code rtems_clock_set(
* This routine implements the rtems_clock_tick directive. It is invoked
* to inform RTEMS of the occurrence of a clock tick.
*
* @return This directive always returns RTEMS_SUCCESSFUL.
* @retval This directive always returns RTEMS_SUCCESSFUL.
*
* @note This method is typically called from an ISR and is the basis
* for all timeouts and delays. This routine only works for leap-years
@@ -225,7 +228,7 @@ rtems_status_code rtems_clock_set_nanoseconds_extension(
*
* @param[in] uptime is a pointer to the time structure
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the uptime will be
* filled in.
@@ -246,7 +249,7 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );
/**
* @brief Returns the system uptime in seconds.
*
* @return The system uptime in seconds.
* @retval The system uptime in seconds.
*/
time_t rtems_clock_get_uptime_seconds( void );
@@ -258,7 +261,7 @@ time_t rtems_clock_get_uptime_seconds( void );
*
* @param[in] the_tod is the TOD structure to validate
*
* @return This method returns true if the TOD is valid and false otherwise.
* @retval This method returns true if the TOD is valid and false otherwise.
*
* @note This routine only works for leap-years through 2099.
*/
@@ -273,7 +276,7 @@ bool _TOD_Validate(
*
* @param[in] the_tod is the TOD structure to convert to seconds
*
* @return This method returns the number of seconds since epoch represented
* @retval This method returns the number of seconds since epoch represented
* by @a the_tod
*/
Watchdog_Interval _TOD_To_seconds(

5
cpukit/rtems/include/rtems/rtems/event.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/event.h
*
* @brief Information Related to the Event Manager
* @defgroup ClassicEvent Events
*
* @ingroup ClassicRTEMS
* @brief Information Related to Event Manager
*
* This include file contains the information pertaining to the Event
* Manager. This manager provides a high performance method of communication

5
cpukit/rtems/include/rtems/rtems/eventmp.h
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/eventmp.h
*
* @defgroup ClassicEventMP Event MP Support
*
* @ingroup ClassicRTEMS
* @brief Event Manager MP Support
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Event Manager.
*/

5
cpukit/rtems/include/rtems/rtems/eventset.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/eventset.h
*
* @brief Information Related to the Event Sets Handler
* @defgroup ClassicEventSet Event Set
*
* @ingroup ClassicRTEMS
* @brief Event Sets Handler
*
* This include file contains the information pertaining to the
* Event Sets Handler. This handler provides methods for the manipulation

7
cpukit/rtems/include/rtems/rtems/intr.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/intr.h
*
* @brief Header file for the Interrupt Manager.
* @defgroup ClassicINTR Interrupts
*
* @ingroup ClassicRTEMS
* @brief Header file for Interrupt Manager
*
* This include file contains all the constants and structures associated with
* the Interrupt Manager.
@@ -73,7 +76,7 @@ typedef rtems_isr ( *rtems_isr_entry )(
* @param[in] vector is the interrupt vector number
* @param[in] old_isr_handler address at which to store previous ISR address
*
* @return RTEMS_SUCCESSFUL and *old_isr_handler filled with previous ISR
* @retval RTEMS_SUCCESSFUL and *old_isr_handler filled with previous ISR
* address
*/
rtems_status_code rtems_interrupt_catch(

21
cpukit/rtems/include/rtems/rtems/message.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/message.h
*
* @brief Constants and Structures Associated with the Message Queue Manager
* @defgroup ClassicMessageQueue Message Queues
*
* @ingroup ClassicRTEMS
* @brief Message Queue Manager
*
* This include file contains all the constants and structures associated
* with the Message Queue Manager. This manager provides a mechanism for
@@ -121,7 +124,7 @@ void _Message_queue_Manager_initialization(void);
* @param[in] attribute_set is the process method
* @param[in] id is the pointer to queue
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the @a id will
* be filled in with the queue id.
@@ -149,7 +152,7 @@ rtems_status_code rtems_message_queue_create(
* @param[in] node is the node(s) to be searched
* @param[in] id is the pointer to message queue id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *id filled with the message queue id
*/
rtems_status_code rtems_message_queue_ident(
@@ -166,7 +169,7 @@ rtems_status_code rtems_message_queue_ident(
*
* @param[in] id is the queue id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_message_queue_delete(
rtems_id id
@@ -206,7 +209,7 @@ rtems_status_code rtems_message_queue_send(
* @param[in] buffer is the pointer to message buffer
* @param[in] size is the size of message to send urgently
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_message_queue_urgent(
rtems_id id,
@@ -227,7 +230,7 @@ rtems_status_code rtems_message_queue_urgent(
* @param[in] size is the size of message to broadcast
* @param[in] count pointer to area to store number of threads made ready
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *count filled in with number of threads made ready
*/
rtems_status_code rtems_message_queue_broadcast(
@@ -254,7 +257,7 @@ rtems_status_code rtems_message_queue_broadcast(
* @param[in] option_set is the options on receive
* @param[in] timeout is the number of ticks to wait
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -320,7 +323,7 @@ rtems_status_code _Message_queue_Submit(
* This function allocates a message queue control block from
* the inactive chain of free message queue control blocks.
*
* @return the_message_queue filled in if successful, NULL otherwise
* @retval the_message_queue filled in if successful, NULL otherwise
*/
Message_queue_Control *_Message_queue_Allocate (void);
@@ -332,7 +335,7 @@ Message_queue_Control *_Message_queue_Allocate (void);
*
* @param[in] the_message_queue_status is the status code to translate
*
* @return translated RTEMS status code
* @retval translated RTEMS status code
*/
rtems_status_code _Message_queue_Translate_core_message_queue_return_code (
uint32_t the_message_queue_status

7
cpukit/rtems/include/rtems/rtems/modes.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/modes.h
*
* @brief Constants and Structures Associated with the RTEMS thread and RTEMS_ASR modes
* @defgroup ClassicModes Modes
*
* @ingroup ClassicRTEMS
* @brief RTEMS thread and RTEMS_ASR modes
*
* This include file contains all constants and structures associated
* with the RTEMS thread and RTEMS_ASR modes.
@@ -108,7 +111,7 @@ extern const uint32_t rtems_interrupt_mask;
*
* @param[in] level is the desired interrupt level
*
* @return This methods returns a mode with the desired interrupt
* @retval This methods returns a mode with the desired interrupt
* @a level in the proper bitfield location.
*
* @note This variable is used by bindings from languages other than

7
cpukit/rtems/include/rtems/rtems/msgmp.h
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/msgmp.h
*
* @defgroup ClassicMsgMP Message Queue MP Support
*
* @ingroup ClassicRTEMS
* @brief Message Manager MP Support
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Message Manager.
*/
@@ -119,7 +124,7 @@ void _Message_queue_MP_Send_response_packet (
/**
*
@brief * _Message_queue_MP_Process_packet
* @brief _Message_queue_MP_Process_packet
*
* This routine performs the actions specific to this package for
* the request from another node.

5
cpukit/rtems/include/rtems/rtems/options.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/options.h
*
* @brief Information Which Defines the Options Available on Many Directives.
* @defgroup ClassicOptions Classic API Options
*
* @ingroup ClassicRTEMS
* @brief Options Available on Many Directives
*
* This include file contains information which defines the
* options available on many directives.

5
cpukit/rtems/include/rtems/rtems/semmp.h
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/semmp.h
*
* @defgroup ClassicSEM Semaphore MP Support
*
* @ingroup ClassicRTEMS
* @brief Semaphore Manager MP Support
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Semaphore Manager.
*/

5
cpukit/rtems/include/rtems/rtems/signalmp.h
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/signalmp.h
*
* @defgroup ClassicSignalMP Signal MP Support
*
* @ingroup ClassicRTEMS
* @brief Signal MP Support
*
* This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Signal Manager.
*/

5
cpukit/rtems/include/rtems/rtems/support.h
View File

@@ -1,10 +1,9 @@
/**
* @file
*
* @defgroup ClassicRTEMSWorkspace Workspace
*
* @ingroup ClassicRTEMS
*
* @ingroup ClassicRTEMSWorkspace
*
* @brief Classic API support.
*/

5
cpukit/rtems/include/rtems/rtems/taskmp.h
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/taskmp.h
*
* @defgroup ClassicTaskMP Task MP Support
*
* @ingroup ClassicRTEMS
* @brief Task Manager MP Support
*
* This include file contains all the constants and structures associated
* with the multiprocessing support in the task manager.
*/

19
cpukit/rtems/include/rtems/rtems/timer.h
View File

@@ -1,7 +1,10 @@
/**
* @file rtems/rtems/timer.h
*
* @brief Constants, Structures, and Prototypes Associated with the Timer Manager
* @defgroup ClassicTimer Timers
*
* @ingroup ClassicRTEMS
* @brief Instantiate RTEMS Timer Data
*
* This include file contains all the constants, structures, and
* prototypes associated with the Timer Manager. This manager provides
@@ -240,7 +243,7 @@ void _Timer_Manager_initialization(void);
* @param[in] name is the timer name
* @param[out] id is the pointer to timer id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_timer_create(
rtems_name name,
@@ -258,7 +261,7 @@ rtems_status_code rtems_timer_create(
* @param[in] name is the user defined message queue name
* @param[in] id is the pointer to timer id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* id filled with the message queue id
*/
rtems_status_code rtems_timer_ident(
@@ -284,7 +287,7 @@ rtems_status_code rtems_timer_cancel(
*
* @param[in] id is the timer id
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -306,7 +309,7 @@ rtems_status_code rtems_timer_delete(
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -331,7 +334,7 @@ rtems_status_code rtems_timer_fire_after(
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -356,7 +359,7 @@ rtems_status_code rtems_timer_server_fire_after(
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
*
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
*/
@@ -443,7 +446,7 @@ typedef struct {
* @param[in] id is the timer id
* @param[in] the_info is the pointer to timer information block
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *the_info region information block filled in
*/
rtems_status_code rtems_timer_get_information(

5
cpukit/rtems/inline/rtems/rtems/asr.inl
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/asr.inl
*
* @defgroup ClassicASR ASR Support
*
* @ingroup ClassicRTEMS
* @brief Asynchronous Signal Handler
*
* This include file contains the implemenation of all routines
* associated with the asynchronous signal handler which are inlined.
*/

5
cpukit/rtems/inline/rtems/rtems/barrier.inl
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/barrier.inl
*
* @defgroup ClassicBarrier Barriers
*
* @ingroup ClassicRTEMS
* @brief Inline Implementation from Barrier Manager
*
* This file contains the static inlin implementation of the inlined
* routines from the Barrier Manager.
*/

5
cpukit/rtems/inline/rtems/rtems/region.inl
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/region.inl
*
* @defgroup ClassicRegion
*
* @ingroup ClassicRTEMS
* @brief Macro Implementation from Region Manager
*
* This file contains the macro implementation of the inlined
* routines from the Region Manager.
*/

5
cpukit/rtems/inline/rtems/rtems/timer.inl
View File

@@ -1,6 +1,11 @@
/**
* @file rtems/rtems/timer.inl
*
* @defgroup ClassicTimer Timers
*
* @ingroup ClassicRTEMS
* @brief Inline Implementation from Timer Manager
*
* This file contains the static inline implementation of the inlined routines
* from the Timer Manager.
*/