Mirrors_Framework/rtems
1
0 Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-11-09 08:37:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

score: Doxygen Clean Up Task #2

Browse Source
This commit is contained in:
Mathew Kallada authored and Jennifer Averett committed 2012-12-28 18:04:01 -06:00
1 parent 3cf4031c19
commit 319cb20efb
19 files changed
+324 -258
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

cpukit/score/include/rtems/score/basedefs.h
+11 -2
View File
@@ -3,7 +3,7 @@
*
* @ingroup Score
*
* @brief Basic definitions.
* @brief Basic Definitions
*/
/*
@@ -20,6 +20,13 @@
#ifndef _RTEMS_BASEDEFS_H
#define _RTEMS_BASEDEFS_H
/**
* @defgroup ScoreBaseDefs Basic Definitions
*
* @ingroup Score
*/
/**@{*/
#include <rtems/score/cpuopts.h>
#ifndef ASM
@@ -189,4 +196,6 @@
typedef void * proc_ptr;
#endif
#endif /* _RTEMS_BASEDEFS_H */
/**@}*/
#endif /* _RTEMS_BASEDEFS_H */
cpukit/score/include/rtems/score/bitfield.h
+7 -3
View File
@@ -1,7 +1,9 @@
/**
* @file rtems/score/bitfield.h
* @file rtems/score/bitfield.h
*
* This include file contains all bit field manipulation routines.
* @brief Bit Field Manipulation Routines
*
* This include file contains all bit field manipulation routines.
*/
/*
@@ -64,6 +66,8 @@ const unsigned char __log2table[256] = {
#endif
/**
* @brief Gets the @a _bit_number of the first bit set in the specified value.
*
* This routine returns the @a _bit_number of the first bit set
* in the specified value. The correspondence between @a _bit_number
* and actual bit position is processor dependent. The search for
@@ -103,4 +107,4 @@ const unsigned char __log2table[256] = {
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/copyrt.h
+11 -1
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/copyrt.h
*
* @brief Copyright Notice for RTEMS
*
* This include file contains the copyright notice for RTEMS
* which is included in every binary copy of the executive.
*/
@@ -17,6 +19,13 @@
#ifndef _RTEMS_SCORE_COPYRT_H
#define _RTEMS_SCORE_COPYRT_H
/**
* @defgroup SuperCore RTEMS Copyright Notice
*
* @ingroup Score
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -36,5 +45,6 @@ extern const char _Copyright_Notice[];
}
#endif
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/coremsg.h
+43 -41
View File
File diff suppressed because it is too large. Load diff
cpukit/score/include/rtems/score/coremutex.h
+25 -21
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/coremutex.h
*
* @brief Constants and Structures Associated with the Mutex Handler
*
* This include file contains all the constants and structures associated
* with the Mutex Handler. A mutex is an enhanced version of the standard
* Dijkstra binary semaphore used to provide synchronization and mutual
@@ -40,7 +42,7 @@ extern "C" {
#include <rtems/score/sysstate.h>
/**
* @brief MP Support Callback Prototype
* @brief Callout which provides to support global/multiprocessor operations.
*
* The following type defines the callout which the API provides
* to support global/multiprocessor operations on mutexes.
@@ -51,7 +53,7 @@ typedef void ( *CORE_mutex_API_mp_support_callout )(
);
/**
* @brief Blocking Disciplines Enumerated Type
* @brief The blocking disciplines for a mutex.
*
* This enumerated type defines the blocking disciplines for a mutex.
*/
@@ -71,7 +73,7 @@ typedef enum {
} CORE_mutex_Disciplines;
/**
* @brief Mutex method return statuses
* @brief The possible Mutex handler return statuses.
*
* This enumerated type defines the possible Mutex handler return statuses.
*/
@@ -118,14 +120,14 @@ typedef enum {
} CORE_mutex_Status;
/**
* @brief Core Mutex Last Status
* @brief The last status value.
*
* This is the last status value.
*/
#define CORE_MUTEX_STATUS_LAST CORE_MUTEX_STATUS_CEILING_VIOLATED
/**
* @brief Mutex Lock Nesting Behavior Enumeration
* @brief The possible behaviors for lock nesting.
*
* This enumerated type defines the possible behaviors for
* lock nesting.
@@ -170,7 +172,7 @@ typedef enum {
#define CORE_MUTEX_LOCKED 0
/**
* @brief Core Mutex Attributes
* @brief The control block used to manage attributes of each mutex.
*
* The following defines the control block used to manage the
* attributes of each mutex.
@@ -195,7 +197,8 @@ typedef struct {
} CORE_mutex_Attributes;
#ifdef __RTEMS_STRICT_ORDER_MUTEX__
/*@brief Core Mutex Lock_Chain Struct
/**
* @brief The control block to manage lock chain of priority inheritance mutex.
*
* The following defines the control block used to manage lock chain of
* priority inheritance mutex.
@@ -214,7 +217,7 @@ typedef struct {
#endif
/**
* @brief Core Mutex Control Structure
* @brief Control block used to manage each mutex.
*
* The following defines the control block used to manage each mutex.
*/
@@ -251,7 +254,7 @@ typedef struct {
} CORE_mutex_Control;
/**
* @brief Initialize a Core Mutex
* @brief Initializes the mutex based on the parameters passed.
*
* This routine initializes the mutex based on the parameters passed.
*
@@ -260,7 +263,7 @@ typedef struct {
* mutex instance
* @param[in] initial_lock is the initial value of the mutex
*
* @return This method returns CORE_MUTEX_STATUS_SUCCESSFUL if successful.
* @retval This method returns CORE_MUTEX_STATUS_SUCCESSFUL if successful.
*/
CORE_mutex_Status _CORE_mutex_Initialize(
CORE_mutex_Control *the_mutex,
@@ -270,7 +273,7 @@ CORE_mutex_Status _CORE_mutex_Initialize(
#ifndef __RTEMS_APPLICATION__
/**
* @brief Seize Mutex with Quick Success Path
* @brief Attempt to receive a unit from the_mutex.
*
* This routine attempts to receive a unit from the_mutex.
* If a unit is available or if the wait flag is false, then the routine
@@ -280,7 +283,7 @@ CORE_mutex_Status _CORE_mutex_Initialize(
* @param[in] the_mutex is the mutex to attempt to lock
* @param[in] level_p is the interrupt level holder
*
* @return This routine returns 0 if "trylock" can resolve whether or not
* @retval This routine returns 0 if "trylock" can resolve whether or not
* the mutex is immediately obtained or there was an error attempting to
* get it. It returns 1 to indicate that the caller cannot obtain
* the mutex and will have to block to do so.
@@ -296,7 +299,8 @@ RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock_body(
#if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__)
/**
* @brief Trylock CORE Mutex Seize Interrupt
* @brief Interrupt trylock CORE mutex seize.
*
* When doing test coverage analysis or trying to minimize the code
* space for RTEMS, it is often helpful to not inline this method
* multiple times. It is fairly large and has a high branch complexity
@@ -322,7 +326,7 @@ RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock_body(
#endif
/**
* @brief Seize Mutex with Blocking
* @brief Performs the blocking portion of a mutex obtain.
*
* This routine performs the blocking portion of a mutex obtain.
* It is an actual subroutine and is not implemented as something
@@ -336,13 +340,13 @@ void _CORE_mutex_Seize_interrupt_blocking(
Watchdog_Interval timeout
);
/**
* @brief Sieze Interrupt Wrapper
* @brief Verifies that a mutex blocking seize is performed safely.
*
* This macro is to verify that a mutex blocking seize is
* 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.
* @retval this method returns true if dispatch is in an unsafe state.
*/
#ifdef RTEMS_SMP
#define _CORE_mutex_Check_dispatch_for_seize(_wait) 0
@@ -354,7 +358,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
#endif
/**
* @brief Sieze Interrupt Wrapper
* @brief Attempt to obtain the mutex.
*
* This routine attempts to obtain the mutex. If the mutex is available,
* then it will return immediately. Otherwise, it will invoke the
@@ -430,7 +434,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
#endif
/**
* @brief Surrender the Mutex
* @brief Frees a unit to the mutex.
*
* This routine frees a unit to the mutex. If a task was blocked waiting for
* a unit from this mutex, then that task will be readied and the unit
@@ -441,7 +445,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
* @param[in] api_mutex_mp_support is the routine that will be called when
* unblocking a remote mutex
*
* @return an indication of whether the routine succeeded or failed
* @retval an indication of whether the routine succeeded or failed
*/
CORE_mutex_Status _CORE_mutex_Surrender(
CORE_mutex_Control *the_mutex,
@@ -450,7 +454,7 @@ CORE_mutex_Status _CORE_mutex_Surrender(
);
/**
* @brief Flush all waiting threads
* @brief Flush all waiting threads.
*
* This routine assists in the deletion of a mutex by flushing the associated
* wait queue.
@@ -477,4 +481,4 @@ void _CORE_mutex_Flush(
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/corerwlock.h
+11 -8
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/corerwlock.h
*
* @brief Constants and Structures Associated with the RWLock Handler
*
* This include file contains all the constants and structures associated
* with the RWLock Handler.
*/
@@ -125,7 +127,7 @@ typedef struct {
} CORE_RWLock_Control;
/**
* @brief Initialize a RWlock
* @brief Initialize a RWlock.
*
* This routine initializes the RWLock based on the parameters passed.
*
@@ -138,7 +140,8 @@ void _CORE_RWLock_Initialize(
);
/**
* @brief Obtain RWLock for reading
* @brief Obtain RWLock for reading.
*
* This routine attempts to obtain the RWLock for read access.
*
* @param[in] the_rwlock is the RWLock to wait for
@@ -161,8 +164,8 @@ void _CORE_RWLock_Obtain_for_reading(
);
/**
* @brief RWLock Obtain for Writing
*
* @brief Obtain RWLock for writing.
*
* This routine attempts to obtain the RWLock for write exclusive access.
*
* @param[in] the_rwlock is the RWLock to wait for
@@ -184,14 +187,14 @@ void _CORE_RWLock_Obtain_for_writing(
);
/**
* @brief Releases the RWLock
* @brief Release the RWLock.
*
* This routine manually releases @a the_rwlock. All of the threads waiting
* for the RWLock will be readied.
*
* @param[in] the_rwlock is the RWLock to surrender
*
* @return Status is returned to indicate successful or failure.
* @retval Status is returned to indicate successful or failure.
*/
CORE_RWLock_Status _CORE_RWLock_Release(
CORE_RWLock_Control *the_rwlock
@@ -214,7 +217,7 @@ CORE_RWLock_Status _CORE_RWLock_Release(
)
/**
* @brief RWLock Specific Thread Queue Timeout
* @brief RWLock specific thread queue timeout.
*
* This routine processes a thread which timeouts while waiting on
* an RWLock's thread queue. It is called by the watchdog handler.
@@ -240,4 +243,4 @@ void _CORE_RWLock_Timeout(
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/heap.h
+2 -2
View File
@@ -3,7 +3,7 @@
*
* @ingroup ScoreHeap
*
* @brief Heap Handler API.
* @brief Heap Handler API
*/
/*
@@ -786,4 +786,4 @@ Heap_Block *_Heap_Block_allocate(
#endif
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/interr.h
+3 -1
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/interr.h
*
* @brief Constants and Prototypes Related to the Internal Error Handler
*
* This include file contains constants and prototypes related
* to the Internal Error Handler.
*/
@@ -214,4 +216,4 @@ void _Internal_error_Occurred(
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/rbtree.h
+18 -16
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/rbtree.h
*
* @brief Constants and Structures Associated with the Red-Black Tree Handler
*
* This include file contains all the constants and structures associated
* with the Red-Black Tree Handler.
*/
@@ -80,7 +82,7 @@ struct RBTree_Node_struct {
};
/**
* @brief macro to return the structure containing the @a node.
* @brief Macro to return the structure containing the @a node.
*
* This macro returns a pointer of type @a container_type that points
* to the structure containing @a node, where @a node_field_name is the
@@ -184,12 +186,12 @@ RBTree_Control name = RBTREE_INITIALIZER_EMPTY(name)
RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name)
/**
* @brief Initialize a RBTree Header
* @brief Initialize a RBTree Header.
*
* This routine initializes @a the_rbtree structure to manage the
* contiguous array of @a number_nodes nodes which starts at
* @a starting_address. Each node is of @a node_size bytes.
*
*
* @param[in] the_rbtree is the pointer to rbtree header
* @param[in] starting_address is the starting address of first node
* @param[in] number_nodes is the number of nodes in rbtree
@@ -205,13 +207,13 @@ void _RBTree_Initialize(
);
/**
* @brief Obtain the min or max node of a rbtree
* @brief Obtain the min or max node of a rbtree.
*
* This function removes the min or max node from @a the_rbtree and returns
* a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
* @a dir specifies whether to return the min (0) or max (1).
*
* @return This method returns a pointer to a node. If a node was removed,
* @retval This method returns a pointer to a node. If a node was removed,
* then a pointer to that node is returned. If @a the_rbtree was
* empty, then NULL is returned.
*
@@ -223,20 +225,20 @@ RBTree_Node *_RBTree_Get(
);
/**
* @brief Find the node with given key in the tree
* @brief Find the node with given key in the tree.
*
* This function returns a pointer to the node with key equal to a key
* of @a the_node if it exists in the Red-Black Tree @a the_rbtree,
* and NULL if not.
*
*
* @param[in] the_rbtree pointer to rbtree control
* @param[in] the_node node with the key to search for
* @return This method returns pointer to control header of rbtree. *
* @retval This method returns pointer to control header of rbtree. *
* If there is no control header available (the node is not part
* of a tree), then NULL is returned. *
*
* - INTERRUPT LATENCY:
* + single case
* + single case
*/
RBTree_Node *_RBTree_Find(
RBTree_Control *the_rbtree,
@@ -244,7 +246,7 @@ RBTree_Node *_RBTree_Find(
);
/**
* @brief Find the control structure of the tree containing the given node
* @brief Find the control structure of the tree containing the given node.
*
* This function returns a pointer called @a return_header to the control structure of the tree
* containing @a the_node, if it exists, and @a NULL if not.
@@ -252,7 +254,7 @@ RBTree_Node *_RBTree_Find(
* @param[in] the_node is the pointer to the rbtree node.
* @param[out] return_header is the pointer to control header of rbtree.
* @param[out] NULL is returned if there is no control header available.
*
*
* -INTERRUPT LATENCY:
* + single case
*/
@@ -261,7 +263,7 @@ RBTree_Control *_RBTree_Find_header(
);
/**
* @brief Insert a Node (unprotected)
* @brief Insert @a the_node on the Red-Black Tree @a the_rbtree (unprotected).
*
* This routine inserts @a the_node on the Red-Black Tree @a the_rbtree.
*
@@ -279,7 +281,7 @@ RBTree_Node *_RBTree_Insert_unprotected(
);
/**
* @brief Insert a node on a rbtree
* @brief Insert a node on a rbtree.
*
* This routine inserts @a the_node on the tree @a the_rbtree.
*
@@ -298,7 +300,7 @@ RBTree_Node *_RBTree_Insert(
/**
* @brief Extract a Node (unprotected)
* @brief Extracts (removes) @a the_node from @a the_rbtree (unprotected).
*
* This routine extracts (removes) @a the_node from @a the_rbtree.
*
@@ -311,7 +313,7 @@ void _RBTree_Extract_unprotected(
);
/**
* @brief Delete a node from the rbtree
* @brief Delete a node from the rbtree.
*
* This routine deletes @a the_node from @a the_rbtree.
*
@@ -391,4 +393,4 @@ void _RBTree_Iterate_unprotected(
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/schedulercbs.h
+37 -32
View File
File diff suppressed because it is too large. Load diff
cpukit/score/include/rtems/score/schedulerpriority.h
+21 -16
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/schedulerpriority.h
*
* @brief Thread Manipulation with the Priority-Based Scheduler
*
* This include file contains all the constants and structures associated
* with the manipulation of threads for the priority-based scheduler.
*/
@@ -26,8 +28,11 @@ extern "C" {
#endif
/**
* @addtogroup ScoreScheduler
* @defgroup ScoreScheduler Priority-based Scheduler
*
* @ingroup Score
*
* @addtogroup ScoreScheduler
*/
/**@{*/
@@ -64,13 +69,13 @@ typedef struct {
} Scheduler_priority_Per_thread;
/**
* @brief Initialize Scheduler Priority
* @brief Initializes the priority scheduler.
* This routine initializes the priority scheduler.
*/
void _Scheduler_priority_Initialize(void);
/**
* @brief Scheduler priority Block
* @brief Removes @a the_thread from the scheduling decision.
*
* This routine removes @a the_thread from the scheduling decision,
* that is, removes it from the ready queue. It performs
@@ -84,7 +89,7 @@ void _Scheduler_priority_Block(
);
/**
* @brief schedule entry point
* @brief Sets the heir thread to be the next ready thread.
*
* This kernel routine sets the heir thread to be the next ready thread
* by invoking the_scheduler->ready_queue->operations->first().
@@ -92,7 +97,7 @@ void _Scheduler_priority_Block(
void _Scheduler_priority_Schedule(void);
/**
* @brief Allocate Scheduler Priority
* @brief Allocates @a the_thread->scheduler.
*
* This routine allocates @a the_thread->scheduler.
*
@@ -104,7 +109,7 @@ void * _Scheduler_priority_Allocate(
);
/**
* @brief Free Scheduler Priority
* @brief Frees @a the_thread->scheduler.
*
* This routine frees @a the_thread->scheduler.
*
@@ -116,7 +121,7 @@ void _Scheduler_priority_Free(
);
/**
* @brief Update Scheduler priority
* @brief Update the scheduler priority.
* This routine updates @a the_thread->scheduler based on @a the_scheduler
* structures and thread state.
*
@@ -128,7 +133,7 @@ void _Scheduler_priority_Update(
);
/**
* @brief Scheduler Priority Unblock
* @brief Add @a the_thread to the scheduling decision.
*
* This routine adds @a the_thread to the scheduling decision,
* that is, adds it to the ready queue and
@@ -141,7 +146,7 @@ void _Scheduler_priority_Unblock(
);
/**
* @brief Scheduler Priority Yield
* @brief Remove the running THREAD to the rear of this chain.
*
* This routine is invoked when a thread wishes to voluntarily
* transfer control of the processor to another thread in the queue.
@@ -160,7 +165,7 @@ void _Scheduler_priority_Unblock(
void _Scheduler_priority_Yield( void );
/**
* @brief Scheduler Priority Enqueue
* @brief Puts @a the_thread on to the priority-based ready queue.
*
* This routine puts @a the_thread on to the priority-based ready queue.
*
@@ -171,7 +176,7 @@ void _Scheduler_priority_Enqueue(
);
/**
* @brief Scheduler Priority Enqueue First
* @brief Puts @a the_thread to the head of the ready queue.
*
* This routine puts @a the_thread to the head of the ready queue.
* For priority-based ready queues, the thread will be the first thread
@@ -184,7 +189,7 @@ void _Scheduler_priority_Enqueue_first(
);
/**
* @brief Removes a specific thread from scheduler
* @brief Remove a specific thread from scheduler.
*
* This routine removes a specific thread from the scheduler's set
* of ready threads.
@@ -196,7 +201,7 @@ void _Scheduler_priority_Extract(
);
/**
* @brief Scheduler priority Priority compare
* @brief Compare two priorities.
*
* This routine compares two priorities.
*/
@@ -206,7 +211,7 @@ int _Scheduler_priority_Priority_compare(
);
/**
* @brief Scheduler priority Release job
* @brief Called when a new job of task is released.
*
* This routine is called when a new job of task is released.
*
@@ -220,7 +225,7 @@ void _Scheduler_priority_Release_job (
);
/**
* @brief Deterministic Priority Scheduler Tick Method
* @brief Determines if the current thread allows timeslicing.
*
* This routine is invoked as part of processing each clock tick.
* It is responsible for determining if the current thread allows
@@ -249,4 +254,4 @@ extern Priority_bit_map_Control _Priority_Bit_map[16] CPU_STRUCTURE_ALIGNMENT;
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/smp.h
+10 -6
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/smp.h
*
* @brief Interface to the SuperCore SMP Support used Internally to RTEMS
*
* This include file defines the interface to the SuperCore
* SMP support that is used internally to RTEMS.
*/
@@ -65,7 +67,7 @@ extern "C" {
#ifndef ASM
/**
* @brief Number of CPUs in SMP System
* @brief Number of CPUs in a SMP system.
*
* This variable is set during the SMP initialization sequence to
* indicate the number of CPUs in this system.
@@ -73,7 +75,7 @@ extern "C" {
SCORE_EXTERN uint32_t _SMP_Processor_count;
/**
* @brief Make Request of Others CPUs
* @brief Request of others CPUs.
*
* This method is invoked by RTEMS when it needs to make a request
* of the other CPUs. It should be implemented using some type of
@@ -87,7 +89,7 @@ void _SMP_Broadcast_message(
);
/**
* @brief Request Other Cores to Perform First Context Switch
* @brief Request other cores to perform first context switch.
*
* Send message to other cores requesting them to perform
* their first context switch operation.
@@ -95,7 +97,7 @@ void _SMP_Broadcast_message(
void _SMP_Request_other_cores_to_perform_first_context_switch(void);
/**
* @brief Request Dispatch on Other Cores
* @brief Request dispatch on other cores.
*
* Send message to other cores requesting them to perform
* a thread dispatch operation.
@@ -103,7 +105,7 @@ void _SMP_Request_other_cores_to_perform_first_context_switch(void);
void _SMP_Request_other_cores_to_dispatch(void);
/**
* @Brief Request Other Cores to Shutdown
* @Brief Request other cores to shutdown.
*
* Send message to other cores requesting them to shutdown.
*/
@@ -116,5 +118,7 @@ void _SMP_Request_other_cores_to_shutdown(void);
#endif
#endif
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/sysstate.h
+1 -1
View File
@@ -3,7 +3,7 @@
*
* @ingroup ScoreSysState
*
* @brief System State Handler API.
* @brief System State Handler API
*/
/*
cpukit/score/include/rtems/score/thread.h
+43 -38
View File
File diff suppressed because it is too large. Load diff
cpukit/score/include/rtems/score/threadq.h
+28 -25
View File
File diff suppressed because it is too large. Load diff
cpukit/score/include/rtems/score/timestamp.h
+30 -28
View File
File diff suppressed because it is too large. Load diff
cpukit/score/include/rtems/score/tod.h
+16 -14
View File
@@ -1,6 +1,8 @@
/**
* @file rtems/score/tod.h
*
* @brief Constants and Structures Associated with the Time of Day Handler.
*
* This include file contains all the constants and structures associated
* with the Time of Day Handler.
*/
@@ -105,7 +107,7 @@ extern "C" {
(4 * TOD_SECONDS_PER_DAY))
/**
* @brief RTEMS Epoch Year
* @brief Earliest year to which an time of day can be initialized.
*
* The following constant define the earliest year to which an
* time of day can be initialized. This is considered the
@@ -157,7 +159,7 @@ typedef struct {
SCORE_EXTERN TOD_Control _TOD;
/**
* @brief Seconds Since RTEMS Epoch
* @brief Number of seconds Since RTEMS epoch.
*
* The following contains the number of seconds from 00:00:00
* January 1, TOD_BASE_YEAR until the current time of day.
@@ -166,14 +168,14 @@ SCORE_EXTERN TOD_Control _TOD;
_Timestamp_Get_seconds(&_TOD.now)
/**
* @brief Initializes the Time of Day Handler
* @brief Initializes the time of day handler.
*
* Performs the initialization necessary for the Time Of Day handler.
*/
void _TOD_Handler_initialization(void);
/**
* @brief Sets the time of day from timestamp
* @brief Sets the time of day from timestamp.
*
* The @a tod_as_timestamp timestamp represents the time since UNIX epoch.
* The watchdog seconds chain will be adjusted.
@@ -206,7 +208,7 @@ static inline void _TOD_Set(
* @param[out] snapshot The snapshot.
* @param[in] source The clock.
*
* @return The snapshot.
* @retval The snapshot.
*/
Timestamp_Control *_TOD_Get_with_nanoseconds(
Timestamp_Control *snapshot,
@@ -226,7 +228,7 @@ static inline void _TOD_Get(
}
/**
* @brief _TOD_Get_uptime
* @brief Gets the system uptime with potential accuracy to the nanosecond.
*
* This routine returns the system uptime with potential accuracy
* to the nanosecond.
@@ -241,7 +243,7 @@ static inline void _TOD_Get_uptime(
}
/**
* @brief _TOD_Get_uptime_as_timespec
* @brief Gets the system uptime with potential accuracy to the nanosecond.
*
* This routine returns the system uptime with potential accuracy
* to the nanosecond.
@@ -253,7 +255,7 @@ void _TOD_Get_uptime_as_timespec(
);
/**
* @brief Increments time of day at each clock tick
* @brief Increments time of day at each clock tick.
*
* This routine increments the ticks field of the current time of
* day at each clock tick.
@@ -261,7 +263,7 @@ void _TOD_Get_uptime_as_timespec(
void _TOD_Tickle_ticks( void );
/**
* @brief TOD_MILLISECONDS_TO_MICROSECONDS
* @brief Converts an interval expressed in milliseconds to microseconds.
*
* This routine converts an interval expressed in milliseconds to microseconds.
*
@@ -270,7 +272,7 @@ void _TOD_Tickle_ticks( void );
#define TOD_MILLISECONDS_TO_MICROSECONDS(_ms) ((uint32_t)(_ms) * 1000L)
/**
* @brief Converts microseconds to ticks
* @brief Converts an interval expressed in microseconds to ticks.
*
* This routine converts an interval expressed in microseconds to ticks.
*
@@ -281,7 +283,7 @@ uint32_t TOD_MICROSECONDS_TO_TICKS(
);
/**
* @brief TOD_MILLISECONDS_TO_TICKS
* @brief Converts an interval expressed in milliseconds to ticks.
*
* This routine converts an interval expressed in milliseconds to ticks.
*
@@ -292,7 +294,7 @@ uint32_t TOD_MILLISECONDS_TO_TICKS(
);
/**
* @brief How many ticks in a second?
* @brief Gets number of ticks in a second.
*
* This method returns the number of ticks in a second.
*
@@ -302,7 +304,7 @@ uint32_t TOD_MILLISECONDS_TO_TICKS(
uint32_t TOD_TICKS_PER_SECOND_method(void);
/**
* @brief Method to return number of ticks in a second
* @brief Gets number of ticks in a second.
*
* This method exists to hide the fact that TOD_TICKS_PER_SECOND can not
* be implemented as a macro in a .h file due to visibility issues.
@@ -322,4 +324,4 @@ uint32_t TOD_TICKS_PER_SECOND_method(void);
/**@}*/
#endif
/* end of include file */
/* end of include file */
cpukit/score/include/rtems/score/userext.h
+1 -1
View File
@@ -3,7 +3,7 @@
*
* @ingroup ScoreUserExt
*
* @brief User Extension Handler API.
* @brief User Extension Handler API
*/
/*
cpukit/score/include/rtems/score/userextimpl.h
+6 -2
View File
@@ -3,7 +3,7 @@
*
* @ingroup ScoreUserExt
*
* @brief User Extension Handler API.
* @brief User Extension Handler API
*/
/*
@@ -25,6 +25,10 @@ extern "C" {
#endif
/**
* @defgroup ScoreUserExt User Extension Handler
*
* @ingroup Score
*
* @addtogroup ScoreUserExt
*
* @{
@@ -246,4 +250,4 @@ static inline void _User_extensions_Fatal(
#endif
#endif
/* end of include file */
/* end of include file */