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

score: Doxygen Clean Up Task #1

Browse Source
This commit is contained in:
Mathew Kallada
2012-12-29 10:27:48 -06:00
committed by Jennifer Averett
parent b98bb9e973
commit 1dbbc0c3b1
20 changed files with 244 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
cpukit/score/include/rtems/debug.h
View File

@@ -22,6 +22,13 @@
#include <rtems/score/basedefs.h>
/**
* @defgroup ScoreDebug Debug Information
*
* @ingroup Score
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -47,26 +54,26 @@ typedef uint32_t rtems_debug_control;
SCORE_EXTERN rtems_debug_control _Debug_Level;
/**
* @brief Initialize Debug Manager
* @brief Initialize debug manager.
*/
void _Debug_Manager_initialization( void );
/**
* @brief Enable Debugging
* @brief Enable debugging.
*/
void rtems_debug_enable(
rtems_debug_control to_be_enabled
);
/**
* @brief Disable Debugging
* @brief Disable debugging.
*/
void rtems_debug_disable(
rtems_debug_control to_be_disabled
);
/**
* @brief Check if Debug is Enabled
* @brief Check if debug is enabled.
*
* This routine returns TRUE if the requested debug level is
* enabled, and FALSE otherwise.
@@ -79,5 +86,6 @@ bool rtems_debug_is_enabled(
}
#endif
/**@}*/
#endif
/* end of include file */

10
cpukit/score/include/rtems/score/apiext.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/apiext.h
*
* @brief API Extensions Handler
*
* This is the API Extensions Handler.
*/
@@ -106,14 +108,14 @@ SCORE_EXTERN Chain_Control _API_extensions_List;
SCORE_EXTERN Chain_Control _API_extensions_Post_switch_list;
/**
* @brief Initialize the API Extensions Handler
* @brief Initialize the API extensions handler.
*
* This routine initializes the API extension handler.
*/
void _API_extensions_Initialization( void );
/**
* @brief Add Extension Set to the Active Set
* @brief Add extension set to the active set.
*
* This routine adds @a the_extension to the active set of API extensions.
*
@@ -142,7 +144,7 @@ void _API_extensions_Add_post_switch(
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
/**
* @brief Execute all Pre-Driver Extensions
* @brief Execute all pre-driver extensions.
*
* This routine executes all of the predriver callouts.
*/
@@ -150,7 +152,7 @@ void _API_extensions_Add_post_switch(
#endif
/**
* @brief Execute all Post-Driver Extensions
* @brief Execute all post-driver extensions.
*
* This routine executes all of the postdriver callouts.
*/

22
cpukit/score/include/rtems/score/context.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/context.h
*
* @brief Information About Each Thread's Context
*
* This include file contains all information about each thread's context.
*/
@@ -36,7 +38,7 @@ extern "C" {
#include <rtems/score/cpu.h>
/**
* @brief Size of Floating Point Context Area
* @brief Size of floating point context area.
*
* This constant defines the number of bytes required
* to store a full floating point context.
@@ -44,7 +46,7 @@ extern "C" {
#define CONTEXT_FP_SIZE CPU_CONTEXT_FP_SIZE
/**
* @brief Initialize Context Area
* @brief Initialize context area.
*
* This routine initializes @a _the_context such that the stack
* pointer, interrupt level, and entry point are correct for the
@@ -79,7 +81,7 @@ extern "C" {
#endif
/**
* @brief Perform Context Switch
* @brief Perform context switch.
*
* This routine saves the current context into the @a _executing
* context record and restores the context specified by @a _heir.
@@ -91,7 +93,7 @@ extern "C" {
_CPU_Context_switch( _executing, _heir )
/**
* @brief Restart Currently Executing Thread
* @brief Restart currently executing thread.
*
* This routine restarts the calling thread by restoring its initial
* stack pointer and returning to the thread's entry point.
@@ -103,7 +105,7 @@ extern "C" {
#if defined(RTEMS_SMP)
/*
* @brief Switch to First Task on Secondary Core
* @brief Switch to first task on secondary core.
*
* This routine is only used to switch to the first task on a
* secondary core in an SMP configuration. Since the switch
@@ -119,7 +121,7 @@ extern "C" {
#endif
/**
* @brief Return Starting Address of Floating Point Context
* @brief Return starting address of floating point context.
*
* This function returns the starting address of the floating
* point context save area. It is assumed that the are reserved
@@ -129,13 +131,13 @@ extern "C" {
* context save area.
* @param[in] _offset is the offset into the floating point area
*
* @return the initial FP context pointer
* @retval the initial FP context pointer
*/
#define _Context_Fp_start( _base, _offset ) \
_CPU_Context_Fp_start( (_base), (_offset) )
/**
* @brief Initialize Floating Point Context Area
* @brief Initialize floating point context area.
*
* This routine initializes the floating point context save
* area to contain an initial known state.
@@ -147,7 +149,7 @@ extern "C" {
_CPU_Context_Initialize_fp( _fp_area )
/**
* @brief Restore Floating Point Context Area
* @brief Restore floating point context area.
*
* This routine restores the floating point context contained
* in the @a _fp area. It is assumed that the current
@@ -160,7 +162,7 @@ extern "C" {
_CPU_Context_restore_fp( _fp )
/**
* @brief Save Floating Point Context Area
* @brief Save floating point context area.
*
* This routine saves the current floating point context
* in the @a _fp area.

15
cpukit/score/include/rtems/score/corebarrier.h
View File

@@ -1,5 +1,7 @@
/**
* @file rtems/score/corebarrier.h
* @file rtems/score/corebarrier.h
*
* @brief Constants and Structures Associated with the Barrier Handler
*
* This include file contains all the constants and structures associated
* with the Barrier Handler.
@@ -82,7 +84,7 @@ typedef enum {
} CORE_barrier_Status;
/**
* @brief Core Barrier Last Status
* @brief Core barrier last status value.
*
* This is the last status value.
*/
@@ -121,7 +123,7 @@ typedef struct {
} CORE_barrier_Control;
/**
* @brief Initialize CORE Barrier
* @brief Initialize core barrier.
*
* This routine initializes the barrier based on the parameters passed.
*
@@ -134,7 +136,8 @@ void _CORE_barrier_Initialize(
);
/**
* @brief Wait For The Barrier
* @brief Wait for the barrier.
*
* This routine wait for the barrier to be released. If the barrier
* is set to automatic and this is the appropriate thread, then it returns
* immediately. Otherwise, the calling thread is blocked until the barrier
@@ -159,7 +162,7 @@ void _CORE_barrier_Wait(
);
/**
* @brief Manually releases the barrier
* @brief Manually release the barrier.
*
* This routine manually releases the barrier. All of the threads waiting
* for the barrier will be readied.
@@ -169,7 +172,7 @@ void _CORE_barrier_Wait(
* @param[in] api_barrier_mp_support is the routine to invoke if the
* thread unblocked is remote
*
* @return the number of unblocked threads
* @retval the number of unblocked threads
*/
uint32_t _CORE_barrier_Release(
CORE_barrier_Control *the_barrier,

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/coresem.h
*
* @brief Data Associated with the Counting Semaphore Handler
*
* This include file contains all the constants and structures associated
* with the Counting Semaphore Handler. A counting semaphore is the
* standard Dijkstra binary semaphore used to provide synchronization
@@ -90,7 +92,7 @@ typedef enum {
} CORE_semaphore_Status;
/**
* @brief Core Semaphore Last Status
* @brief Core semaphore last status value.
*
* This is the last status value.
*/
@@ -127,7 +129,7 @@ typedef struct {
} CORE_semaphore_Control;
/**
* @brief Core Semaphore Initialize
* @brief Initialize the semaphore based on the parameters passed.
*
* DESCRIPTION:
*
@@ -170,7 +172,7 @@ void _CORE_semaphore_Initialize(
#endif
/**
* @brief Surrenders a Unit to a Semaphore
* @brief Surrender a unit to a semaphore.
*
* This routine frees a unit to the semaphore. If a task was blocked waiting
* for a unit from this semaphore, then that task will be readied and the unit
@@ -182,7 +184,7 @@ void _CORE_semaphore_Initialize(
* @param[in] api_semaphore_mp_support is the routine to invoke if the
* thread unblocked is remote
*
* @return an indication of whether the routine succeeded or failed
* @retval an indication of whether the routine succeeded or failed
*/
CORE_semaphore_Status _CORE_semaphore_Surrender(
CORE_semaphore_Control *the_semaphore,
@@ -191,7 +193,7 @@ CORE_semaphore_Status _CORE_semaphore_Surrender(
);
/**
* @brief Core Semaphore Flush
* @brief Core semaphore flush.
*
* DESCRIPTION:
* This package is the implementation of the CORE Semaphore Handler.

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/isrlevel.h
*
* @brief ISR Level Type
*
* This include file defines the ISR Level type. It exists to
* simplify include dependencies. It is part of the ISR Handler.
*/
@@ -22,6 +24,10 @@ extern "C" {
#endif
/**
* @defgroup ScoreISR ISR Handler
*
* @ingroup Score
*
* @addtogroup ScoreISR ISR Handler
*/
/**@{*/
@@ -38,4 +44,3 @@ typedef uint32_t ISR_Level;
}
#endif
#endif

40
cpukit/score/include/rtems/score/mpci.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/mpci.h
*
* @brief Constants and Structures Associated with the MPCI Layer
*
* This include file contains all the constants and structures associated
* with the MPCI layer. It provides mechanisms to utilize packets.
*/
@@ -180,7 +182,7 @@ SCORE_EXTERN Thread_queue_Control _MPCI_Remote_blocked_threads;
SCORE_EXTERN MPCI_Control *_MPCI_table;
/**
* @brief Pointer to MP Thread Control Block
* @brief Pointer to MP thread control block.
*
* The following is used to determine when the multiprocessing receive
* thread is executing so that a proxy can be allocated instead of
@@ -196,7 +198,7 @@ SCORE_EXTERN MPCI_Packet_processor
_MPCI_Packet_processors[MP_PACKET_CLASSES_LAST+1];
/**
* @brief Initialization of the MPCI Handler
* @brief Initialize the MPCI handler.
*
* This routine performs the initialization necessary for this handler.
*
@@ -208,14 +210,14 @@ void _MPCI_Handler_initialization(
);
/**
* @brief Create the MPCI Server Thread
* @brief Create the MPCI server thread.
*
* This routine creates the packet receive server used in MP systems.
*/
void _MPCI_Create_server( void );
/**
* @brief Initialize the MPCI driver
* @brief Initialize the MPCI driver.
*
* This routine initializes the MPCI driver by
* invoking the user provided MPCI initialization callout.
@@ -241,14 +243,14 @@ void _MPCI_Register_packet_processor(
* This function obtains a packet by invoking the user provided
* MPCI get packet callout.
*
* @return This method returns a pointer to a MPCI packet which can be
* @retval This method returns a pointer to a MPCI packet which can be
* filled in by the caller and used to perform a subsequent
* remote operation.
*/
MP_packet_Prefix *_MPCI_Get_packet ( void );
/**
* @brief Deallocate a packet
* @brief Deallocate a packet.
*
* This routine deallocates a packet by invoking the user provided
* MPCI return packet callout.
@@ -260,7 +262,7 @@ void _MPCI_Return_packet (
);
/**
* @brief Send a process packet
* @brief Send a process packet.
*
* This routine sends a process packet by invoking the user provided
* MPCI send callout.
@@ -274,7 +276,7 @@ void _MPCI_Send_process_packet (
);
/**
* @brief Send a request packet
* @brief Send a request packet.
*
* This routine sends a request packet by invoking the user provided
* MPCI send callout.
@@ -286,7 +288,7 @@ void _MPCI_Send_process_packet (
* may indicate the caller is blocking on a message queue
* operation.
*
* @return This method returns the operation status from the remote node.
* @retval This method returns the operation status from the remote node.
*/
uint32_t _MPCI_Send_request_packet (
uint32_t destination,
@@ -295,7 +297,7 @@ uint32_t _MPCI_Send_request_packet (
);
/**
* @brief Send a response packet
* @brief Send a response packet.
*
* This routine sends a response packet by invoking the user provided
* MPCI send callout.
@@ -309,17 +311,17 @@ void _MPCI_Send_response_packet (
);
/**
* @brief Receive a packet
* @brief Receive a packet.
*
* This routine receives a packet by invoking the user provided
* MPCI receive callout.
*
* @return This method returns the packet received.
* @retval This method returns the packet received.
*/
MP_packet_Prefix *_MPCI_Receive_packet ( void );
/**
* @brief Pass a packet to the thread
* @brief Pass a packet to the thread.
*
* This routine is responsible for passing @a the_packet to the thread
* waiting on the remote operation to complete. The unblocked thread is
@@ -327,7 +329,7 @@ MP_packet_Prefix *_MPCI_Receive_packet ( void );
*
* @param[in] the_packet is the response packet to be processed.
*
* @return This method returns a pointer to the thread which was if unblocked
* @retval This method returns a pointer to the thread which was if unblocked
* or NULL if the waiting thread no longer exists.
*/
Thread_Control *_MPCI_Process_response (
@@ -335,7 +337,7 @@ Thread_Control *_MPCI_Process_response (
);
/**
* @brief Receive and process all packets
* @brief Receive and process all packets.
*
* This is the server thread which receives and processes all MCPI packets.
*
@@ -346,14 +348,14 @@ Thread _MPCI_Receive_server(
);
/**
* @brief Announce the availability of a packet
* @brief Announce the availability of a packet.
*
* This routine informs RTEMS of the availability of an MPCI packet.
*/
void _MPCI_Announce ( void );
/**
* @brief Perform a process on another node
* @brief Perform a process on another node.
*
* This routine performs a remote procedure call so that a
* process operation can be performed on another node.
@@ -385,7 +387,7 @@ void _MPCI_Internal_packets_Send_process_packet (
*/
/**
* @brief Perform requested action from another node
* @brief Perform requested action from another node.
*
* This routine performs the actions specific to this package for
* the request from another node.
@@ -417,7 +419,7 @@ void _MPCI_Internal_packets_Process_packet (
*/
/**
* @brief Obtain an internal thread
* @brief Obtain an internal thread.
*
* This routine is used to obtain an internal threads MP packet.
*/

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/mppkt.h
*
* @brief Specification for the Packet Handler
*
* This package is the specification for the Packet Handler.
* This handler defines the basic packet and provides
* mechanisms to utilize packets based on this prefix.

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/object.h
*
* @brief Constants and Structures Associated with the Object Handler
*
* This include file contains all the constants and structures associated
* with the Object Handler. This Handler provides mechanisms which
* can be used to initialize and manipulate all objects which have ids.
@@ -40,6 +42,7 @@ extern "C" {
*
* @brief Provides services for all APIs.
*/
/**@{*/
/**
* @defgroup ScoreCPU CPU Architecture Support
@@ -48,12 +51,14 @@ extern "C" {
*
* @brief Provides CPU architecture dependent services.
*/
/**@{*/
/**
* @defgroup ScoreObject Object Handler
*
* @ingroup Score
*/
/**@{*/
/**
* The following type defines the control block used to manage
@@ -502,20 +507,18 @@ void _Objects_Initialize_information (
*
* @param[in] api is the API of interest
*
* @return A positive integer on success and 0 otherwise.
* @retval A positive integer on success and 0 otherwise.
*/
unsigned int _Objects_API_maximum_class(
uint32_t api
);
/**
* @brief Allocate Object
* @brief Allocate an object.
*
* This function allocates a object control block from
* This function allocates an object control block from
* the inactive chain of free object control blocks.
*
* @brief Allocate Object
*
* @param[in] information points to an object class information block.
*/
Objects_Control *_Objects_Allocate(
@@ -523,9 +526,9 @@ Objects_Control *_Objects_Allocate(
);
/**
* @brief Free Object
* @brief Free an object.
*
* This function frees a object control block to the
* This function frees an object control block to the
* inactive chain of free object control blocks.
*
* @param[in] information points to an object class information block.
@@ -583,7 +586,8 @@ typedef enum {
#define OBJECTS_NAME_ERRORS_LAST OBJECTS_INVALID_NODE
/**
* @brief Object Name To Id
* @brief Converts an object name to an Id.
*
* This method converts an object name to an Id. It performs a look up
* using the object information block for this object class.
*
@@ -592,7 +596,7 @@ typedef enum {
* @param[in] node is the set of nodes to search.
* @param[in] id will contain the Id if the search is successful.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a id will contain the Id of
* the requested object.
@@ -606,7 +610,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
#if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)
/**
* @brief Object ID to Name
* @brief Converts an object name to an Id.
*
* This method converts an object name to an Id. It performs a look up
* using the object information block for this object class.
@@ -615,7 +619,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
* @param[in] name is the name of the object to find.
* @param[in] id will contain the Id if the search is successful.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a id will contain the Id of
* the requested object.
@@ -628,7 +632,8 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
#endif
/**
* @brief Object Id To Name
* @brief Implements the common portion of the object Id to name directives.
*
* This function implements the common portion of the object Id
* to name directives. This function returns the name
* associated with object id.
@@ -636,7 +641,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
* @param[in] id is the Id of the object whose name we are locating.
* @param[in] name will contain the name of the object, if found.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a name will contain the name of
* the requested object.
@@ -649,7 +654,8 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
);
/**
* @brief Get Object
* @brief Maps object ids to object control blocks.
*
* This function maps object ids to object control blocks.
* If id corresponds to a local object, then it returns
* the_object control pointer which maps to id and location
@@ -663,7 +669,7 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
* @param[in] id is the Id of the object whose name we are locating.
* @param[in] location will contain an indication of success or failure.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a id will contain the Id of
* the requested object.
@@ -680,7 +686,7 @@ Objects_Control *_Objects_Get (
);
/**
* @brief Object Get Isr Disable
* @brief Maps object ids to object control blocks.
*
* This function maps object ids to object control blocks.
* If id corresponds to a local object, then it returns
@@ -696,7 +702,7 @@ Objects_Control *_Objects_Get (
* @param[in] location will contain an indication of success or failure.
* @param[in] level is the interrupt level being turned.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a name will contain the name of
* the requested object.
@@ -714,7 +720,7 @@ Objects_Control *_Objects_Get_isr_disable(
);
/**
* @brief Get No protection Object
* @brief Maps object ids to object control blocks.
*
* This function maps object ids to object control blocks.
* If id corresponds to a local object, then it returns
@@ -729,7 +735,7 @@ Objects_Control *_Objects_Get_isr_disable(
* @param[in] id is the Id of the object whose name we are locating.
* @param[in] location will contain an indication of success or failure.
*
* @return This method returns one of the values from the
* @retval This method returns one of the values from the
* @ref Objects_Name_or_id_lookup_errors enumeration to indicate
* successful or failure. On success @a id will contain the Id of
* the requested object.
@@ -753,7 +759,7 @@ Objects_Control *_Objects_Get_no_protection(
* @param[in] location_p will contain an indication of success or failure.
* @param[in] next_id_p is the Id of the next object we will look at.
*
* @return This method returns the pointer to the object located or
* @retval This method returns the pointer to the object located or
* NULL on error.
*/
Objects_Control *_Objects_Get_next(
@@ -764,7 +770,7 @@ Objects_Control *_Objects_Get_next(
);
/**
* @brief Get Object Information
* @brief Get object information.
*
* This function return the information structure given
* an the API and Class. This can be done independent of
@@ -773,7 +779,7 @@ Objects_Control *_Objects_Get_next(
* @param[in] the_api indicates the API for the information we want
* @param[in] the_class indicates the Class for the information we want
*
* @return This method returns a pointer to the Object Information Table
* @retval This method returns a pointer to the Object Information Table
* for the class of objects which corresponds to this object ID.
*/
Objects_Information *_Objects_Get_information(
@@ -782,14 +788,14 @@ Objects_Information *_Objects_Get_information(
);
/**
* @brief Get Information of an Object from an ID
* @brief Get information of an object from an ID.
*
* This function return the information structure given
* an @a id of an object.
*
* @param[in] id is the object ID to get the information from
*
* @return This method returns a pointer to the Object Information Table
* @retval This method returns a pointer to the Object Information Table
* for the class of objects which corresponds to this object ID.
*/
Objects_Information *_Objects_Get_information_id(
@@ -797,7 +803,7 @@ Objects_Information *_Objects_Get_information_id(
);
/**
* @brief _Objects_Get_name_as_string
* @brief Gets object name in the form of a C string.
*
* This method objects the name of an object and returns its name
* in the form of a C string. It attempts to be careful about
@@ -807,7 +813,7 @@ Objects_Information *_Objects_Get_information_id(
* @param[in] length indicates the length of the caller's buffer
* @param[in] name points a string which will be filled in.
*
* @return This method returns @a name or NULL on error. @a *name will
* @retval This method returns @a name or NULL on error. @a *name will
* contain the name if successful.
*/
char *_Objects_Get_name_as_string(
@@ -817,7 +823,7 @@ char *_Objects_Get_name_as_string(
);
/**
* @brief Set Objects Name
* @brief Set objects name.
*
* This method sets the object name to either a copy of a string
* or up to the first four characters of the string based upon
@@ -827,7 +833,7 @@ char *_Objects_Get_name_as_string(
* @param[in] the_object is the object to operate upon
* @param[in] name is a pointer to the name to use
*
* @return If successful, true is returned. Otherwise false is returned.
* @retval If successful, true is returned. Otherwise false is returned.
*/
bool _Objects_Set_name(
Objects_Information *information,
@@ -836,7 +842,7 @@ bool _Objects_Set_name(
);
/**
* @brief Removes Object from Namespace
* @brief Removes object from namespace.
*
* This function removes @a the_object from the namespace.
*
@@ -849,7 +855,7 @@ void _Objects_Namespace_remove(
);
/**
* @brief Close Object
* @brief Close object.
*
* This function removes the_object control pointer and object name
* in the Local Pointer and Local Name Tables.
@@ -867,7 +873,7 @@ void _Objects_Close(
*
* @param[in] information The object information table.
*
* @return The count of active objects.
* @retval The count of active objects.
*/
Objects_Maximum _Objects_Active_count(
const Objects_Information *information
@@ -886,5 +892,8 @@ Objects_Maximum _Objects_Active_count(
}
#endif
/**@}*/
/**@}*/
/**@}*/
#endif
/* end of include file */

26
cpukit/score/include/rtems/score/objectmp.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/objectmp.h
*
* @brief Data Associated with the Manipulation of Global RTEMS Objects
*
* This include file contains all the constants and structures associated
* with the manipulation of Global RTEMS Objects.
*/
@@ -47,7 +49,8 @@ typedef struct {
} Objects_MP_Control;
/**
* @brief Objects MP Handler initialization
* @brief Intializes the inactive global object chain
* based on the maximum number of global objects configured.
*
* This routine intializes the inactive global object chain
* based on the maximum number of global objects configured.
@@ -55,7 +58,8 @@ typedef struct {
void _Objects_MP_Handler_initialization(void);
/**
* @brief Objects MP Handler Early Initialization
* @brief Intializes the global object node number
* used in the ID field of all objects.
*
* This routine intializes the global object node number
* used in the ID field of all objects.
@@ -63,7 +67,8 @@ void _Objects_MP_Handler_initialization(void);
void _Objects_MP_Handler_early_initialization(void);
/**
* @brief Objects MP Open
* @brief Place the specified global object in the
* specified information table.
*
* This routine place the specified global object in the
* specified information table.
@@ -85,7 +90,8 @@ void _Objects_MP_Open (
);
/**
* @brief Objects MP Allocate and open
* @brief Allocates a global object control block
* and places it in the specified information table.
*
* This routine allocates a global object control block
* and places it in the specified information table. If the
@@ -110,7 +116,7 @@ bool _Objects_MP_Allocate_and_open (
);
/**
* @brief Objects MP Close
* @brief Removes a global object from the specified information table.
*
* This routine removes a global object from the specified
* information table and deallocates the global object control block.
@@ -121,7 +127,8 @@ void _Objects_MP_Close (
);
/**
* @brief Objects MP Global name search
* @brief Look for the object with the_name in the global
* object tables indicated by information.
*
* This routine looks for the object with the_name in the global
* object tables indicated by information. It returns the ID of the
@@ -133,7 +140,7 @@ void _Objects_MP_Close (
* @param[in] nodes_to_search indicates the set of nodes to search.
* @param[in] the_id will contain the Id of the object if found.
*
* @return This method returns one of the
* @retval This method returns one of the
* @ref Objects_Name_or_id_lookup_errors. If successful, @a the_id
* will contain the Id of the object.
*/
@@ -145,7 +152,8 @@ Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search (
);
/**
* @brief Objects MP Is remote
* @brief Searches the Global Object Table managed
* by information for the object indicated by ID.
*
* This function searches the Global Object Table managed
* by information for the object indicated by ID. If the object
@@ -159,7 +167,7 @@ Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search (
* @param[in] location will contain the location of the object.
* @param[in] the_object will contain a pointer to the object.
*
* @return This method fills in @a location to indicate successful location
* @retval This method fills in @a location to indicate successful location
* of the object or error. On success, @a the_object will be
* filled in.
*/

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/priority.h
*
* @brief Thread Priority Manipulation Routines
*
* This include file contains all thread priority manipulation routines.
* This Handler provides mechanisms which can be used to
* initialize and manipulate thread priorities.

11
cpukit/score/include/rtems/score/prioritybitmap.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/prioritybitmap.h
*
* @brief Manipulation Routines for the Bitmap Priority Queue Implementation
*
* This include file contains all thread priority manipulation routines for
* the bit map priority queue implementation.
*/
@@ -18,8 +20,11 @@
#define _RTEMS_SCORE_PRIORITYBITMAP_H
/**
* @addtogroup ScorePriority
* @defgroup ScorePriority Bitmap Priority Thread Routines
*
* @ingroup Score
*
* @addtogroup ScorePriority
*/
/**@{*/
@@ -86,7 +91,7 @@ typedef struct {
*
* @param[in] _bit_number is the bit number for which we need a mask
*
* @return the priority bit mask
* @retval the priority bit mask
*
* @note This may simply be a pass through to a CPU dependent implementation.
*/
@@ -100,7 +105,7 @@ typedef struct {
*
* @param[in] _priority is the priority for which we need the index.
*
* @return This method returns the array index into the priority bit map.
* @retval This method returns the array index into the priority bit map.
*
* @note This may simply be a pass through to a CPU dependent implementation.
*/

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

@@ -3,7 +3,7 @@
*
* @ingroup ScoreProtHeap
*
* @brief Protected Heap Handler API.
* @brief Protected Heap Handler API
*/
/*

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/scheduler.h
*
* @brief Constants and Structures Associated with the Scheduler
*
* This include file contains all the constants and structures associated
* with the scheduler.
*/
@@ -129,7 +131,7 @@ extern Scheduler_Control _Scheduler;
(_Scheduler_Priority_compare(_p1,_p2) > 0)
/**
* @brief Scheduler is priority higher than
* @brief Initializes the scheduler to the policy chosen by the user.
*
* This routine initializes the scheduler to the policy chosen by the user
* through confdefs, or to the priority scheduler with ready chains by

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/stack.h
*
* @brief Information About the Thread Stack Handler
*
* This include file contains all information about the thread
* Stack Handler. This Handler provides mechanisms which can be used to
* initialize and utilize stacks.

5
cpukit/score/include/rtems/score/states.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/states.h
*
* @brief Thread Execution State Information
*
* This include file contains thread execution state information.
*/
@@ -17,7 +19,8 @@
#define _RTEMS_SCORE_STATES_H
/**
* @defgroup ScoreStates Thread States Handler
* @defgroup Encapsulates functionality which relates to the management of
* the state bitmap associated with each thread.
*
* @ingroup Score
*

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

@@ -35,7 +35,7 @@ extern "C" {
#endif
/**
* @brief Set Timespec to Seconds Nanosecond
* @brief Set timespec to seconds nanosecond.
*
* This method sets the timespec to the specified seconds and nanoseconds
* value.
@@ -51,7 +51,7 @@ extern "C" {
} while (0)
/**
* @brief Zero Timespec
* @brief Sets the Timespec to Zero
*
* This method sets the timespec to zero.
* value.
@@ -65,37 +65,37 @@ extern "C" {
} while (0)
/**
* @brief Get Seconds Portion of Timespec
* @brief Get seconds portion of timespec.
*
* This method returns the seconds portion of the specified timespec
*
* @param[in] _time points to the timespec
*
* @return The seconds portion of @a _time.
* @retval The seconds portion of @a _time.
*/
#define _Timespec_Get_seconds( _time ) \
((_time)->tv_sec)
/**
* @brief Get Nanoseconds Portion of Timespec
* @brief Get nanoseconds portion of timespec.
*
* This method returns the nanoseconds portion of the specified timespec
*
* @param[in] _time points to the timespec
*
* @return The nanoseconds portion of @a _time.
* @retval The nanoseconds portion of @a _time.
*/
#define _Timespec_Get_nanoseconds( _time ) \
((_time)->tv_nsec)
/**
* @brief Is Timespec Valid
* @brief Check if timespec is valid.
*
* This method determines the validity of a timespec.
*
* @param[in] time is the timespec instance to validate.
*
* @return This method returns true if @a time is valid and
* @retval This method returns true if @a time is valid and
* false otherwise.
*/
bool _Timespec_Is_valid(
@@ -103,14 +103,14 @@ bool _Timespec_Is_valid(
);
/**
* @brief Timespec Less Than Operator
* @brief The Timespec "less than" operator.
*
* This method is the less than operator for timespecs.
*
* @param[in] lhs is the left hand side timespec
* @param[in] rhs is the right hand side timespec
*
* @return This method returns true if @a lhs is less than the @a rhs and
* @retval This method returns true if @a lhs is less than the @a rhs and
* false otherwise.
*/
bool _Timespec_Less_than(
@@ -119,28 +119,28 @@ bool _Timespec_Less_than(
);
/**
* @brief Timespec Greater Than Operator
* @brief The Timespec "greater than" operator.
*
* This method is the greater than operator for timespecs.
*
* @param[in] lhs is the left hand side timespec
* @param[in] rhs is the right hand side timespec
*
* @return This method returns true if @a lhs is greater than the @a rhs and
* @retval This method returns true if @a lhs is greater than the @a rhs and
* false otherwise.
*/
#define _Timespec_Greater_than( _lhs, _rhs ) \
_Timespec_Less_than( _rhs, _lhs )
/**
* @brief Timespec equal to Operator
* @brief The Timespec "equal to" operator.
*
* This method is the is equal to than operator for timespecs.
*
* @param[in] lhs is the left hand side timespec
* @param[in] rhs is the right hand side timespec
*
* @return This method returns true if @a lhs is equal to @a rhs and
* @retval This method returns true if @a lhs is equal to @a rhs and
* false otherwise.
*/
#define _Timespec_Equal_to( lhs, rhs ) \
@@ -149,7 +149,7 @@ bool _Timespec_Less_than(
)
/**
* @brief Add to a Timespec
* @brief Add two timespecs.
*
* This routine adds two timespecs. The second argument is added
* to the first.
@@ -157,7 +157,7 @@ bool _Timespec_Less_than(
* @param[in] time is the base time to be added to
* @param[in] add is the timespec to add to the first argument
*
* @return This method returns the number of seconds @a time increased by.
* @retval This method returns the number of seconds @a time increased by.
*/
uint32_t _Timespec_Add_to(
struct timespec *time,
@@ -165,21 +165,21 @@ uint32_t _Timespec_Add_to(
);
/**
* @brief Convert Timespec to Number of Ticks
* @brief Convert timespec to number of ticks.
*
* This routine convert the @a time timespec to the corresponding number
* of clock ticks.
*
* @param[in] time is the time to be converted
*
* @return This method returns the number of ticks computed.
* @retval This method returns the number of ticks computed.
*/
uint32_t _Timespec_To_ticks(
const struct timespec *time
);
/**
* @brief Convert Ticks to Timespec
* @brief Convert ticks to timespec.
*
* This routine converts the @a ticks value to the corresponding
* timespec format @a time.
@@ -193,7 +193,7 @@ void _Timespec_From_ticks(
);
/**
* @brief Subtract Two Timespec
* @brief Subtract two timespec.
*
* This routine subtracts two timespecs. @a result is set to
* @a end - @a start.
@@ -202,7 +202,7 @@ void _Timespec_From_ticks(
* @param[in] end is the ending time
* @param[in] result is the difference between starting and ending time.
*
* @return This method fills in @a result.
* @retval This method fills in @a result.
*/
void _Timespec_Subtract(
const struct timespec *start,
@@ -211,7 +211,7 @@ void _Timespec_Subtract(
);
/**
* @brief Divide Timespec By Integer
* @brief Divide timespec by an integer.
*
* This routine divides a timespec by an integer value. The expected
* use is to assist in benchmark calculations where you typically
@@ -221,7 +221,7 @@ void _Timespec_Subtract(
* @param[in] iterations is the number of iterations
* @param[in] result is the average time.
*
* @return This method fills in @a result.
* @retval This method fills in @a result.
*/
void _Timespec_Divide_by_integer(
const struct timespec *time,
@@ -230,7 +230,7 @@ void _Timespec_Divide_by_integer(
);
/**
* @brief Divide Timespec
* @brief Divide a timespec by anonther timespec.
*
* This routine divides a timespec by another timespec. The
* intended use is for calculating percentages to three decimal points.
@@ -240,7 +240,7 @@ void _Timespec_Divide_by_integer(
* @param[in] ival_percentage is the integer portion of the average
* @param[in] fval_percentage is the thousandths of percentage
*
* @return This method fills in @a result.
* @retval This method fills in @a result.
*/
void _Timespec_Divide(
const struct timespec *lhs,

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

@@ -1,6 +1,8 @@
/**
* @file rtems/score/tqdata.h
*
* @brief Constants and Structures Needed to Declare a Thread Queue
*
* This include file contains all the constants and structures
* needed to declare a thread queue.
*/

58
cpukit/score/include/rtems/score/watchdog.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/score/watchdog.h
*
* @brief Constants and Structures Associated with Watchdog Timers
*
* This include file contains all the constants and structures associated
* with watchdog timers. This Handler provides mechanisms which can be
* used to initialize and manipulate watchdog timers.
@@ -38,7 +40,7 @@ extern "C" {
#endif
/**
* @brief Maximum Interval Length
* @brief Control block used to manage intervals.
*
* The following type defines the control block used to manage
* intervals.
@@ -46,14 +48,15 @@ extern "C" {
#define WATCHDOG_MAXIMUM_INTERVAL ((Watchdog_Interval) 0xffffffff)
/**
* @brief Watchdog Interval Type
* @brief Type is used to specify the length of intervals.
*
* This type is used to specify the length of intervals.
*/
typedef uint32_t Watchdog_Interval;
/**
* @brief Watchdog Nanoseconds Since Last Tick Extension
* @brief Pointer to the BSP plugin to obtain the number
* of nanoseconds since the last clock tick.
*
* This type defines a pointer to the BSP plugin to obtain the number
* of nanoseconds since the last clock tick.
@@ -61,14 +64,14 @@ typedef uint32_t Watchdog_Interval;
typedef uint32_t (*Watchdog_Nanoseconds_since_last_tick_routine)(void);
/**
* @brief Watchdog Service Routine Return Type
* @brief Return type from a Watchdog Service Routine.
*
* This type defines the return type from a Watchdog Service Routine.
*/
typedef void Watchdog_Service_routine;
/**
* @brief Watchdog Service Routine Pointer Type
* @brief Pointer to a watchdog service routine.
*
* This type define a pointer to a watchdog service routine.
*/
@@ -78,7 +81,7 @@ typedef Watchdog_Service_routine ( *Watchdog_Service_routine_entry )(
);
/**
* @brief No timeout constant
* @brief The constant for indefinite wait.
*
* This is the constant for indefinite wait. It is actually an
* illegal interval.
@@ -86,7 +89,7 @@ typedef Watchdog_Service_routine ( *Watchdog_Service_routine_entry )(
#define WATCHDOG_NO_TIMEOUT 0
/**
* @brief Watchdog States Type
* @brief Set of the states which a watchdog timer may be at any given time.
*
* This enumerated type is the set of the states in which a
* watchdog timer may be at any given time.
@@ -108,7 +111,8 @@ typedef enum {
} Watchdog_States;
/**
* @brief Watchdog Adjustment Directions Type
* @brief the manner in which a watchdog chain may
* be adjusted by the @ref _Watchdog_Adjust routine.
*
* The following enumerated type details the manner in which
* a watchdog chain may be adjusted by the @ref _Watchdog_Adjust
@@ -123,7 +127,7 @@ typedef enum {
} Watchdog_Adjust_directions;
/**
* @brief Watchdog Control Structure
* @brief The control block used to manage each watchdog timer.
*
* The following record defines the control block used
* to manage each watchdog timer.
@@ -154,7 +158,7 @@ typedef struct {
} Watchdog_Control;
/**
* @brief Watchdog Synchronization Level
* @brief Watchdog synchronization level.
*
* This used for synchronization purposes
* during an insert on a watchdog delta chain.
@@ -162,7 +166,7 @@ typedef struct {
SCORE_EXTERN volatile uint32_t _Watchdog_Sync_level;
/**
* @brief Watchdog Synchronization Count
* @brief Watchdog synchronization count.
*
* This used for synchronization purposes
* during an insert on a watchdog delta chain.
@@ -170,7 +174,7 @@ SCORE_EXTERN volatile uint32_t _Watchdog_Sync_level;
SCORE_EXTERN volatile uint32_t _Watchdog_Sync_count;
/**
* @brief Ticks Since System Boot
* @brief The number of ticks since the system was booted.
*
* This contains the number of ticks since the system was booted.
*/
@@ -178,7 +182,7 @@ SCORE_EXTERN volatile uint32_t _Watchdog_Sync_count;
SCORE_EXTERN volatile Watchdog_Interval _Watchdog_Ticks_since_boot;
/**
* @brief Watchdog Nanoseconds Since Last Tick Handler
* @brief The number of nanoseconds since the last clock tick.
*
* This is a pointer to the optional BSP plugin to obtain the number
* of nanoseconds since the last clock tick.
@@ -187,21 +191,21 @@ extern Watchdog_Nanoseconds_since_last_tick_routine
_Watchdog_Nanoseconds_since_tick_handler;
/**
* @brief Per Ticks Watchdog List
* @brief Watchdog chain which is managed at ticks.
*
* This is the watchdog chain which is managed at ticks.
*/
SCORE_EXTERN Chain_Control _Watchdog_Ticks_chain;
/**
* @brief Per Seconds Watchdog List
* @brief Watchdog chain which is managed at second boundaries.
*
* This is the watchdog chain which is managed at second boundaries.
*/
SCORE_EXTERN Chain_Control _Watchdog_Seconds_chain;
/**
* @brief Watchdog Handler Initialization
* @brief Initialize the watchdog handler.
*
* This routine initializes the watchdog handler. The watchdog
* synchronization flag is initialized and the watchdog chains are
@@ -210,20 +214,21 @@ SCORE_EXTERN Chain_Control _Watchdog_Seconds_chain;
void _Watchdog_Handler_initialization( void );
/**
* @brief Remove Watchdog from List
* @brief Removes @a the_watchdog from the watchdog chain.
*
* This routine removes @a the_watchdog from the watchdog chain on which
* it resides and returns the state @a the_watchdog timer was in.
*
* @param[in] the_watchdog will be removed
* @return the state in which @a the_watchdog was in when removed
* @retval the state in which @a the_watchdog was in when removed
*/
Watchdog_States _Watchdog_Remove (
Watchdog_Control *the_watchdog
);
/**
* @brief Watchdog Adjust
* @brief Adjusts the @a header watchdog chain in the forward
* or backward @a direction for @a units ticks.
*
* This routine adjusts the @a header watchdog chain in the forward
* or backward @a direction for @a units ticks.
@@ -239,7 +244,8 @@ void _Watchdog_Adjust (
);
/**
* @brief Watchdog Adjust to Chain
* @brief Adjusts the @a header watchdog chain in the forward
* @a direction for @a units_arg ticks.
*
* This routine adjusts the @a header watchdog chain in the forward
* @a direction for @a units_arg ticks.
@@ -259,7 +265,8 @@ void _Watchdog_Adjust_to_chain(
);
/**
* @brief Watchdog Insert
* @brief Inserts @a the_watchdog into the @a header watchdog chain
* for a time of @a units.
*
* This routine inserts @a the_watchdog into the @a header watchdog chain
* for a time of @a units.
@@ -274,7 +281,8 @@ void _Watchdog_Insert (
);
/**
* @brief Watchdog Tickle
* @brief This routine is invoked at appropriate intervals to update
* the @a header watchdog chain.
*
* This routine is invoked at appropriate intervals to update
* the @a header watchdog chain.
@@ -287,7 +295,7 @@ void _Watchdog_Tickle (
);
/**
* @brief Report Information on a Single Watchdog Instance
* @brief Report information on a single watchdog instance.
*
* This method prints a one line report on the watchdog instance
* provided. The @a name may be used to identify the watchdog and
@@ -306,7 +314,7 @@ void _Watchdog_Report(
);
/**
* @brief Report Information on a Watchdog Chain
* @brief Report information on a watchdog chain.
*
* This method prints report on the watchdog chain provided.
* The @a name may be used to identify the watchdog chain and
@@ -326,7 +334,7 @@ void _Watchdog_Report_chain(
);
/**
* @brief Default Nanoseconds Since Last Tick Handler
* @brief Handler for default nanoseconds since last tick.
*
* @retval 0 Always.
*/

8
cpukit/score/include/rtems/system.h
View File

@@ -22,6 +22,13 @@
#include <rtems/score/percpu.h>
/**
* @defgroup ScoreSystem System Information
*
* @ingroup Score
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -54,5 +61,6 @@ extern const char _Copyright_Notice[];
}
#endif
/**@}*/
#endif
/* end of include file */