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

rtems: Doxygen Clean Up Task #1

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

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

@@ -1,9 +1,12 @@
/** /**
* @file * @file
* *
* @ingroup ClassicRTEMS * @defgroup ClassicRTEMS RTEMS Classic API
* *
* @brief Provides the Public Interface to the RTEMS Classic API * @ingroup ClassicRTEMS
* @brief RTEMS Classic API
*
* the Public Interface to the RTEMS Classic API
*/ */
/* COPYRIGHT (c) 1989-2008. /* COPYRIGHT (c) 1989-2008.

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

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/attr.h * @file rtems/rtems/attr.h
* *
* @brief Information about the Object Attributes Handler * @defgroup ClassicAttributes Attributes
*
* @ingroup ClassicRTEMS
* @brief Object Attributes Handler
* *
* This include file contains all information about the Object Attributes * This include file contains all information about the Object Attributes
* Handler. * Handler.

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

@@ -1,6 +1,11 @@
/** /**
* @file rtems/rtems/barriermp.h * @file rtems/rtems/barriermp.h
* *
* @defgroup ClassicBarrierMP Barrier MP Support
*
* @ingroup ClassicMP
* @brief MP Support in the Barrier Manager
*
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Barrier Manager. * with the Multiprocessing Support in the Barrier Manager.
*/ */

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

@@ -1,9 +1,12 @@
/** /**
* @file rtems/rtems/cache.h * @file rtems/rtems/cache.h
* *
* @brief Functionality Associated with the Cache Manager * @defgroup ClassicCache Cache
* *
* Cache Manager * @ingroup ClassicRTEMS
* @brief Cache Manager
*
* Functionality Associated with the Cache Manager
*/ */
/* COPYRIGHT (c) 1989-2008. /* COPYRIGHT (c) 1989-2008.

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

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/config.h * @file rtems/rtems/config.h
* *
* @brief Records Which Define the Configuration Table * @defgroup ClassicConfig Configuration
*
* @ingroup ClassicRTEMS
* @brief Configuration Table
* *
* This include file contains the table of user defined configuration * This include file contains the table of user defined configuration
* parameters specific for the RTEMS API. * parameters specific for the RTEMS API.

18
cpukit/rtems/include/rtems/rtems/dpmem.h
View File

@@ -1,8 +1,10 @@
/** /**
* @file rtems/rtems/dpmem.h * @file rtems/rtems/dpmem.h
* *
* @brief Constants and Structures Associated with the Dual Ported Memory * @defgroup ClassicDPMEM Dual Ported Memory
* Manager *
* @ingroup ClassicRTEMS
* @brief Dual Ported Memory Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Dual Ported Memory Manager. This manager provides a mechanism * with the Dual Ported Memory Manager. This manager provides a mechanism
@@ -102,7 +104,7 @@ void _Dual_ported_memory_Manager_initialization(void);
* @param[in] length is the physical length in bytes * @param[in] length is the physical length in bytes
* @param[out] id is the address of port id to set * @param[out] id is the address of port id to set
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will * source of the error. If successful, the id will
* be filled in with the port id. * be filled in with the port id.
@@ -125,7 +127,7 @@ rtems_status_code rtems_port_create(
* @param[in] name is the user defined port name * @param[in] name is the user defined port name
* @param[out] id is the pointer to port id * @param[out] id is the pointer to port 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_port_ident( rtems_status_code rtems_port_ident(
rtems_name name, rtems_name name,
@@ -140,7 +142,7 @@ rtems_status_code rtems_port_ident(
* *
* @param[in] id is the dual-ported memory area id * @param[in] id is the dual-ported memory area 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -153,7 +155,7 @@ rtems_status_code rtems_port_delete(
* *
* This routine implements the rtems_port_external_to_internal directive. * This routine implements the rtems_port_external_to_internal directive.
* It returns the internal port address which maps to the provided * It returns the internal port address which maps to the provided
* external port address for the specified port ID.If the given external * external port address for the specified port ID. If the given external
* address is an invalid dual-ported address, then the internal address is * address is an invalid dual-ported address, then the internal address is
* set to the given external address. * set to the given external address.
* *
@@ -161,7 +163,7 @@ rtems_status_code rtems_port_delete(
* @param[in] external is the external address * @param[in] external is the external address
* @param[out] internal is the pointer of internal address to set * @param[out] internal is the pointer of internal address to set
* *
* @return RTEMS_SUCCESSFUL * @retval RTEMS_SUCCESSFUL
*/ */
rtems_status_code rtems_port_external_to_internal( rtems_status_code rtems_port_external_to_internal(
rtems_id id, rtems_id id,
@@ -182,7 +184,7 @@ rtems_status_code rtems_port_external_to_internal(
* @param[in] internal is the internal address to set * @param[in] internal is the internal address to set
* @param[in] external is the pointer to external address * @param[in] external is the pointer to external address
* *
* @return RTEMS_SUCCESSFUL and the external will be filled in * @retval RTEMS_SUCCESSFUL and the external will be filled in
* with the external addresses * with the external addresses
*/ */
rtems_status_code rtems_port_internal_to_external( rtems_status_code rtems_port_internal_to_external(

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

@@ -1,6 +1,11 @@
/** /**
* @file rtems/rtems/mp.h * @file rtems/rtems/mp.h
* *
* @defgroup ClassicMP Multiprocessing
*
* @ingroup ClassicRTEMS
* @brief Multiprocessing Manager
*
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Multiprocessing Manager. * with the Multiprocessing Manager.
*/ */

47
cpukit/rtems/include/rtems/rtems/object.h
View File

@@ -1,6 +1,9 @@
/** /**
* @file rtems/rtems/object.h * @file rtems/rtems/object.h
* *
* @defgroup ClassicClassInfo Object Class Information
*
* @ingroup ClassicRTEMS
* @brief Classic API interfaces to Object Services * @brief Classic API interfaces to Object Services
* *
* This include file defines Classic API interfaces to Object Services. * This include file defines Classic API interfaces to Object Services.
@@ -64,7 +67,7 @@ typedef struct {
* @param[in] _node indicates the node to use for the Id * @param[in] _node indicates the node to use for the Id
* @param[in] _index indicates the index to use for the Id * @param[in] _index indicates the index to use for the Id
* *
* @return This method returns an object Id built from the * @retval This method returns an object Id built from the
* specified values. * specified values.
* *
* @note A body is also provided. * @note A body is also provided.
@@ -103,9 +106,9 @@ typedef struct {
* *
* @note The object must be have a name of the 32-bit form. * @note The object must be have a name of the 32-bit form.
* *
* @return @a *name will contain user defined object name * @retval @a *name will contain user defined object name
* @return @a RTEMS_SUCCESSFUL - if successful * @retval @a RTEMS_SUCCESSFUL - if successful
* @return error code - if unsuccessful * @retval error code - if unsuccessful
*/ */
rtems_status_code rtems_object_get_classic_name( rtems_status_code rtems_object_get_classic_name(
rtems_id id, rtems_id id,
@@ -122,9 +125,9 @@ rtems_status_code rtems_object_get_classic_name(
* @param[in] length is the length of the output name buffer * @param[in] length is the length of the output name buffer
* @param[out] name will be set to the name of the object * @param[out] name will be set to the name of the object
* *
* @return @a *name will contain user defined object name * @retval @a *name will contain user defined object name
* @return @a name - if successful * @retval @a name - if successful
* @return @a NULL - if unsuccessful * @retval @a NULL - if unsuccessful
*/ */
char *rtems_object_get_name( char *rtems_object_get_name(
rtems_id id, rtems_id id,
@@ -144,9 +147,9 @@ char *rtems_object_get_name(
* @param[in] id is the Id of the object to obtain the name of * @param[in] id is the Id of the object to obtain the name of
* @param[out] name will be set to the name of the object * @param[out] name will be set to the name of the object
* *
* @return @a *name will contain user defined object name * @retval @a *name will contain user defined object name
* @return @a RTEMS_SUCCESSFUL - if successful * @retval @a RTEMS_SUCCESSFUL - if successful
* @return error code - if unsuccessful * @retval error code - if unsuccessful
*/ */
rtems_status_code rtems_object_set_name( rtems_status_code rtems_object_set_name(
rtems_id id, rtems_id id,
@@ -162,7 +165,7 @@ rtems_status_code rtems_object_set_name(
* *
* @param[in] _id is the Id of the object to obtain the API from * @param[in] _id is the Id of the object to obtain the API from
* *
* @return This method returns the API portion of the provided * @retval This method returns the API portion of the provided
* @a _id. * @a _id.
* *
* @note This method does NOT validate the @a _id provided. * @note This method does NOT validate the @a _id provided.
@@ -179,7 +182,7 @@ rtems_status_code rtems_object_set_name(
* *
* @param[in] _id is the Id of the object to obtain the class from * @param[in] _id is the Id of the object to obtain the class from
* *
* @return This method returns the class portion of the provided * @retval This method returns the class portion of the provided
* @a _id. * @a _id.
* *
* @note This method does NOT validate the @a _id provided. * @note This method does NOT validate the @a _id provided.
@@ -196,7 +199,7 @@ rtems_status_code rtems_object_set_name(
* *
* @param[in] _id is the Id of the object to obtain the node from * @param[in] _id is the Id of the object to obtain the node from
* *
* @return This method returns the node portion of the provided * @retval This method returns the node portion of the provided
* @a _id. * @a _id.
* *
* @note This method does NOT validate the @a _id provided. * @note This method does NOT validate the @a _id provided.
@@ -213,7 +216,7 @@ rtems_status_code rtems_object_set_name(
* *
* @param[in] _id is the Id of the object to obtain the index from * @param[in] _id is the Id of the object to obtain the index from
* *
* @return This method returns the index portion of the provided * @retval This method returns the index portion of the provided
* @a _id. * @a _id.
* *
* @note This method does NOT validate the @a _id provided. * @note This method does NOT validate the @a _id provided.
@@ -229,7 +232,7 @@ rtems_status_code rtems_object_set_name(
* This method returns the lowest valid value for the API * This method returns the lowest valid value for the API
* portion of an RTEMS object Id. * portion of an RTEMS object Id.
* *
* @return This method returns the least valid value for * @retval This method returns the least valid value for
* the API portion of an RTEMS object Id. * the API portion of an RTEMS object Id.
* *
* @note A body is also provided. * @note A body is also provided.
@@ -243,7 +246,7 @@ rtems_status_code rtems_object_set_name(
* This method returns the highest valid value for the API * This method returns the highest valid value for the API
* portion of an RTEMS object Id. * portion of an RTEMS object Id.
* *
* @return This method returns the greatest valid value for * @retval This method returns the greatest valid value for
* the API portion of an RTEMS object Id. * the API portion of an RTEMS object Id.
* *
* @note A body is also provided. * @note A body is also provided.
@@ -260,7 +263,7 @@ rtems_status_code rtems_object_set_name(
* *
* @param[in] api is the API to obtain the minimum class of * @param[in] api is the API to obtain the minimum class of
* *
* @return This method returns the least valid value for * @retval This method returns the least valid value for
* class number for the specified @a api. * class number for the specified @a api.
* RTEMS Object Helper -- Get Least Valid Class for an API * RTEMS Object Helper -- Get Least Valid Class for an API
*/ */
@@ -277,7 +280,7 @@ int rtems_object_api_minimum_class(
* *
* @param[in] api is the API to obtain the maximum class of * @param[in] api is the API to obtain the maximum class of
* *
* @return This method returns the greatet valid value for * @retval This method returns the greatet valid value for
* class number for the specified @a api. * class number for the specified @a api.
*/ */
int rtems_object_api_maximum_class( int rtems_object_api_maximum_class(
@@ -294,7 +297,7 @@ int rtems_object_api_maximum_class(
* *
* @param[in] api is the API to obtain the maximum class of * @param[in] api is the API to obtain the maximum class of
* *
* @return This method returns the least valid value for * @retval This method returns the least valid value for
* class number for the specified @a api. * class number for the specified @a api.
*/ */
int rtems_object_id_api_maximum_class( int rtems_object_id_api_maximum_class(
@@ -309,7 +312,7 @@ int rtems_object_id_api_maximum_class(
* *
* @param[in] api is the API to obtain the name of * @param[in] api is the API to obtain the name of
* *
* @return If successful, this method returns the name of * @retval If successful, this method returns the name of
* the specified @a api. Otherwise, it returns * the specified @a api. Otherwise, it returns
* the string "BAD API" * the string "BAD API"
*/ */
@@ -326,7 +329,7 @@ const char *rtems_object_get_api_name(
* @param[in] the_api is the API for the class * @param[in] the_api is the API for the class
* @param[in] the_class is the class to obtain the name of * @param[in] the_class is the class to obtain the name of
* *
* @return If successful, this method returns the name of * @retval If successful, this method returns the name of
* the specified @a class. Otherwise, it returns * the specified @a class. Otherwise, it returns
* the string "BAD CLASS" * the string "BAD CLASS"
*/ */
@@ -345,7 +348,7 @@ const char *rtems_object_get_api_class_name(
* @param[in] the_class is the class to obtain information about * @param[in] the_class is the class to obtain information about
* @param[in] info points to the information structure to fill in * @param[in] info points to the information structure to fill in
* *
* @return If successful, this method returns the name of * @retval If successful, this method returns the name of
* RTEMS_SUCCESSFUL with @a *info filled in. Otherwise, * RTEMS_SUCCESSFUL with @a *info filled in. Otherwise,
* a status is returned to indicate the error. * a status is returned to indicate the error.
* *

11
cpukit/rtems/include/rtems/rtems/part.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/part.h * @file rtems/rtems/part.h
* *
* @brief Constants and Structures Associated with the Partition Manager * @defgroup ClassicPart Partitions
*
* @ingroup ClassicRTEMS
* @brief Partition Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Partition Manager. This manager provides facilities to * with the Partition Manager. This manager provides facilities to
@@ -131,7 +134,7 @@ rtems_status_code rtems_partition_create(
* @param[in] node is(are) the node(s) to be searched * @param[in] node is(are) the node(s) to be searched
* @param[in] id is the pointer to partition id * @param[in] id is the pointer to partition 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 in with the partition id * *id filled in with the partition id
*/ */
rtems_status_code rtems_partition_ident( rtems_status_code rtems_partition_ident(
@@ -149,7 +152,7 @@ rtems_status_code rtems_partition_ident(
* *
* @param[in] id is the partition id * @param[in] id is the partition 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -167,7 +170,7 @@ rtems_status_code rtems_partition_delete(
* @param[in] id is the partition id * @param[in] id is the partition id
* @param[out] buffer is the pointer to buffer address * @param[out] buffer is the pointer to buffer address
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_partition_get_buffer( rtems_status_code rtems_partition_get_buffer(
rtems_id id, rtems_id id,

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

@@ -1,6 +1,11 @@
/** /**
* @file rtems/rtems/partmp.h * @file rtems/rtems/partmp.h
* *
* @defgroup ClassicPartMP Partition MP Support
*
* @ingroup ClassicMP
* @brief MP Support in Partition Manager
*
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Partition Manager. * with the Multiprocessing Support in the Partition Manager.
*/ */

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

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/ratemon.h * @file rtems/rtems/ratemon.h
* *
* @brief Constants, Structures, and Prototypes Associated to the Classic API Rate Monotonic Manager. * @defgroup ClassicRateMon Rate Monotonic Scheduler
*
* @ingroup ClassicRTEMS
* @brief Classic API Rate Monotonic Manager.
* *
* This include file contains all the constants, structures, and * This include file contains all the constants, structures, and
* prototypes associated with the Rate Monotonic Manager. This manager * prototypes associated with the Rate Monotonic Manager. This manager
@@ -302,7 +305,7 @@ rtems_status_code rtems_rate_monotonic_create(
* @param[in] name is the user defined period name * @param[in] name is the user defined period name
* @param[in] id is the pointer to period id * @param[in] id is the pointer to period 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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will * source of the error. If successful, the id will
* be filled in with the region id. * be filled in with the region id.
@@ -321,7 +324,7 @@ rtems_status_code rtems_rate_monotonic_ident(
* *
* @param[in] id is the rate monotonic id * @param[in] id is the rate monotonic id
* *
* @return RTEMS_SUCCESSFUL if successful and caller is not the owning thread * @retval RTEMS_SUCCESSFUL if successful and caller is not the owning thread
* or error code if unsuccessful * or error code if unsuccessful
* *
*/ */
@@ -337,7 +340,7 @@ rtems_status_code rtems_rate_monotonic_cancel(
* *
* @param[in] id is the rate monotonic id * @param[in] id is the rate monotonic 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -354,7 +357,7 @@ rtems_status_code rtems_rate_monotonic_delete(
* @param[in] id is the rate monotonic id * @param[in] id is the rate monotonic id
* @param[in] status is the pointer to status control block * @param[in] status is the pointer to status control block
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
* *
@@ -373,7 +376,7 @@ rtems_status_code rtems_rate_monotonic_get_status(
* @param[in] id is the rate monotonic id * @param[in] id is the rate monotonic id
* @param[in] statistics is the pointer to statistics control block * @param[in] statistics is the pointer to statistics control block
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_rate_monotonic_get_statistics( rtems_status_code rtems_rate_monotonic_get_statistics(
rtems_id id, rtems_id id,
@@ -433,7 +436,7 @@ void rtems_rate_monotonic_report_statistics( void );
* @param[in] id is the rate monotonic id * @param[in] id is the rate monotonic id
* @param[in] lenght is the length of period (in ticks) * @param[in] lenght is the length of period (in ticks)
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_rate_monotonic_period( rtems_status_code rtems_rate_monotonic_period(
rtems_id id, rtems_id id,
@@ -469,7 +472,7 @@ void _Rate_monotonic_Timeout(
* @param[out] cpu_since_last_period is set to the cpu time used by the * @param[out] cpu_since_last_period is set to the cpu time used by the
* owning thread since the period was initiated. * owning thread since the period was initiated.
* *
* @return This routine returns true if the status can be determined * @retval This routine returns true if the status can be determined
* and false otherwise. * and false otherwise.
*/ */
bool _Rate_monotonic_Get_status( bool _Rate_monotonic_Get_status(

25
cpukit/rtems/include/rtems/rtems/region.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/region.h * @file rtems/rtems/region.h
* *
* @brief Constants and Structures Associated with the Region Manager * @defgroup ClassicRegion Regions
*
* @ingroup ClassicRTEMS
* @brief Region Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Region Manager. This manager provides facilities to dynamically * with the Region Manager. This manager provides facilities to dynamically
@@ -130,7 +133,7 @@ rtems_status_code rtems_region_create(
* @param[in] starting_address starting address of memory area for extension * @param[in] starting_address starting address of memory area for extension
* @param[in] length is the physical length in bytes to grow the region * @param[in] length is the physical length in bytes to grow the region
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -151,7 +154,7 @@ rtems_status_code rtems_region_extend(
* @param[in] name is the user defined region name * @param[in] name is the user defined region name
* @param[in] id is the pointer to region id * @param[in] id is the pointer to region 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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will * source of the error. If successful, the id will
* be filled in with the region id. * be filled in with the region id.
@@ -171,7 +174,7 @@ rtems_status_code rtems_region_ident(
* @param[in] id is the region id * @param[in] id is the region id
* @param[in] the_info is the pointer to region information block * @param[in] the_info is the pointer to region information block
* *
* @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 region information block * *id filled with the region information block
*/ */
rtems_status_code rtems_region_get_information( rtems_status_code rtems_region_get_information(
@@ -190,7 +193,7 @@ rtems_status_code rtems_region_get_information(
* @param[in] id is the region id * @param[in] id is the region id
* @param[in] the_info is the pointer to region information block * @param[in] the_info is the pointer to region information block
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the the_info will * source of the error. If successful, the the_info will
* be filled in with the region information block. * be filled in with the region information block.
@@ -209,7 +212,7 @@ rtems_status_code rtems_region_get_free_information(
* *
* @param[in] id is the region id * @param[in] id is the region 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -234,7 +237,7 @@ rtems_status_code rtems_region_delete(
* @param[in] timeout is the number of ticks to wait (0 means wait forever) * @param[in] timeout is the number of ticks to wait (0 means wait forever)
* @param[in] segment is the pointer to segment address * @param[in] segment is the pointer to segment address
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the segment will * source of the error. If successful, the segment will
* be filled in with the segment address. * be filled in with the segment address.
@@ -257,7 +260,7 @@ rtems_status_code rtems_region_get_segment(
* @param[in] segment is the segment address * @param[in] segment is the segment address
* @param[in] size is the pointer to segment size in bytes * @param[in] size is the pointer to segment size in bytes
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the size will * source of the error. If successful, the size will
* be filled in with the segment size in bytes. * be filled in with the segment size in bytes.
@@ -282,7 +285,7 @@ rtems_status_code rtems_region_get_segment_size(
* @param[in] id is the region id * @param[in] id is the region id
* @param[in] segment is the pointer to segment address * @param[in] segment is the pointer to segment address
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_region_return_segment( rtems_status_code rtems_region_return_segment(
rtems_id id, rtems_id id,
@@ -305,8 +308,8 @@ rtems_status_code rtems_region_return_segment(
* @param[in] id is the region id * @param[in] id is the region id
* @param[in] segmet is the pointer to segment address * @param[in] segmet is the pointer to segment address
* @param[in] size is the new required size * @param[in] size is the new required size
* @return RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the * @retval RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the
* the segment can't be resized in place or any other code atfailure * the segment can't be resized in place or any other code at failure
* *
* @note On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the * @note On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the
* 'old_size' the old size in bytes of the user memory area of the * 'old_size' the old size in bytes of the user memory area of the

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

@@ -1,6 +1,11 @@
/** /**
* @file rtems/rtems/regionmp.h * @file rtems/rtems/regionmp.h
* *
* @defgroup ClassicRegionMP Region MP Support
*
* @ingroup ClassicMP
* @brief Multiprocessing Support in Region Manager
*
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Multiprocessing Support in the Region Manager. * with the Multiprocessing Support in the Region Manager.
*/ */

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

@@ -1,7 +1,14 @@
/** /**
* @file rtems/rtems/rtemsapi.h * @file rtems/rtems/rtemsapi.h
* *
* @defgroup ClassicAPI RTEMS API Support
*
* @ingroup ClassicRTEMS
* @brief RTEMS API Support * @brief RTEMS API Support
*
* This routine initializes the RTEMS API by invoking the initialization
* routine for each RTEMS manager with the appropriate parameters
* from the configuration_table.
*/ */
/* COPYRIGHT (c) 1989-2008. /* COPYRIGHT (c) 1989-2008.

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

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/sem.h * @file rtems/rtems/sem.h
* *
* @brief Constants and Structures Associated with the Semaphore Manager * @defgroup ClassicSem Semaphores
*
* @ingroup ClassicRTEMS
* @brief Semaphore Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Semaphore Manager. This manager utilizes standard Dijkstra * with the Semaphore Manager. This manager utilizes standard Dijkstra
@@ -151,7 +154,7 @@ rtems_status_code rtems_semaphore_create(
* @param[in] node is(are) the node(s) to be searched * @param[in] node is(are) the node(s) to be searched
* @param[in] id is the pointer to semaphore id * @param[in] id is the pointer to semaphore 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 in with the semaphore id * *id filled in with the semaphore id
*/ */
rtems_status_code rtems_semaphore_ident( rtems_status_code rtems_semaphore_ident(
@@ -168,7 +171,7 @@ rtems_status_code rtems_semaphore_ident(
* *
* @param[in] id is the semaphore id * @param[in] id is the semaphore 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -191,7 +194,7 @@ rtems_status_code rtems_semaphore_delete(
* @param[in] option_set is the wait option * @param[in] option_set is the wait option
* @param[in] timeout is the number of ticks to wait (0 means wait forever) * @param[in] timeout is the number of ticks to wait (0 means wait forever)
* *
* @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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -228,7 +231,7 @@ rtems_status_code rtems_semaphore_release(
* *
* @param[in] id is the semaphore id * @param[in] id is the semaphore 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_semaphore_flush( rtems_status_code rtems_semaphore_flush(
rtems_id id rtems_id id
@@ -255,7 +258,7 @@ bool _Semaphore_Seize(
* *
* @param[in] the_mutex_status is the mutex status code to translate * @param[in] the_mutex_status is the mutex status code to translate
* *
* @return translated RTEMS status code * @retval translated RTEMS status code
*/ */
rtems_status_code _Semaphore_Translate_core_mutex_return_code ( rtems_status_code _Semaphore_Translate_core_mutex_return_code (
uint32_t the_mutex_status uint32_t the_mutex_status
@@ -269,7 +272,7 @@ rtems_status_code _Semaphore_Translate_core_mutex_return_code (
* *
* @param[in] status is the semaphore status code to translate * @param[in] status is the semaphore status code to translate
* *
* @return translated RTEMS status code * @retval translated RTEMS status code
*/ */
rtems_status_code _Semaphore_Translate_core_semaphore_return_code ( rtems_status_code _Semaphore_Translate_core_semaphore_return_code (
uint32_t the_mutex_status uint32_t the_mutex_status

9
cpukit/rtems/include/rtems/rtems/signal.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/signal.h * @file rtems/rtems/signal.h
* *
* @brief Constants and Structures Associated with the Signal Manager * @defgroup ClassicSignal Signals
*
* @ingroup ClassicRTEMS
* @brief Signal Manager
* *
* This include file contains all the constants and structures associated * This include file contains all the constants and structures associated
* with the Signal Manager. This manager provides capabilities required * with the Signal Manager. This manager provides capabilities required
@@ -63,7 +66,7 @@ void _Signal_Manager_initialization( void );
* ( NULL indicates asr is invalid ) * ( NULL indicates asr is invalid )
* @param[in] mode_set is the mode value for asr * @param[in] mode_set is the mode value for asr
* *
* @return RTEMS_SUCCESSFUL * @retval RTEMS_SUCCESSFUL
*/ */
rtems_status_code rtems_signal_catch( rtems_status_code rtems_signal_catch(
rtems_asr_entry asr_handler, rtems_asr_entry asr_handler,
@@ -79,7 +82,7 @@ rtems_status_code rtems_signal_catch(
* @param[in] id is the thread thread id * @param[in] id is the thread thread id
* @param[in] signal_set is the signal set * @param[in] signal_set is the signal set
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_signal_send( rtems_status_code rtems_signal_send(
rtems_id id, rtems_id id,

12
cpukit/rtems/include/rtems/rtems/smp.h
View File

@@ -1,8 +1,10 @@
/** /**
* @file rtems/rtems/smp.h * @file rtems/rtems/smp.h
* *
* This include file provides the application interface * @defgroup ClassicSMP Classic API SMP Services
* to SMP information and services. *
* @ingroup ClassicRTEMS
* @brief SMP information and services.
* *
* Most of the SMP interface is hidden from the application * Most of the SMP interface is hidden from the application
* and exists between the BSP and RTEMS. * and exists between the BSP and RTEMS.
@@ -43,7 +45,7 @@ extern uint32_t rtems_configuration_smp_maximum_processors;
* the system. This will always be less than or equal to the number * the system. This will always be less than or equal to the number
* of maximum number of cores which were configured. * of maximum number of cores which were configured.
* *
* @return This method returns the number of cores in this system. * @retval This method returns the number of cores in this system.
*/ */
#define rtems_smp_get_number_of_processors() \ #define rtems_smp_get_number_of_processors() \
(_SMP_Processor_count) (_SMP_Processor_count)
@@ -55,7 +57,7 @@ extern uint32_t rtems_configuration_smp_maximum_processors;
* in the system. The actual number of cores will always be less than * in the system. The actual number of cores will always be less than
* or equal to the number of maximum number of cores which were configured. * or equal to the number of maximum number of cores which were configured.
* *
* @return This method returns the number of cores configured. * @retval This method returns the number of cores configured.
*/ */
#define rtems_configuration_get_smp_maximum_processors() \ #define rtems_configuration_get_smp_maximum_processors() \
(rtems_configuration_smp_maximum_processors) (rtems_configuration_smp_maximum_processors)
@@ -65,7 +67,7 @@ extern uint32_t rtems_configuration_smp_maximum_processors;
* *
* This method returns the id of the current CPU core. * This method returns the id of the current CPU core.
* *
* @return This method returns the id of the current CPU core. * @retval This method returns the id of the current CPU core.
*/ */
#define rtems_smp_get_current_processor() \ #define rtems_smp_get_current_processor() \
bsp_smp_processor_id() bsp_smp_processor_id()

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

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/status.h * @file rtems/rtems/status.h
* *
* @brief Status Codes Returned from the Executive Directives * @defgroup ClassicStatus Status Codes
*
* @ingroup ClassicRTEMS
* @brief Status Codes Returned from Executive Directives
* *
* This include file contains the status codes returned from the * This include file contains the status codes returned from the
* executive directives. * executive directives.

27
cpukit/rtems/include/rtems/rtems/tasks.h
View File

@@ -1,7 +1,10 @@
/** /**
* @file rtems/rtems/tasks.h * @file rtems/rtems/tasks.h
* *
* @brief Constants and Structures Associated with RTEMS Tasks * @defgroup ClassicTasks Tasks
*
* @ingroup ClassicRTEMS
* @brief RTEMS Tasks
* *
* This include file contains all constants and structures associated * This include file contains all constants and structures associated
* with RTEMS tasks. This manager provides a comprehensive set of directives * with RTEMS tasks. This manager provides a comprehensive set of directives
@@ -267,7 +270,7 @@ void _RTEMS_tasks_Manager_initialization(void);
* @param[in] attribute_set is the thread attributes * @param[in] attribute_set is the thread attributes
* @param[in] id is the pointer to thread id * @param[in] id is the pointer to thread id
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
* and *id thread id filled in * and *id thread id filled in
*/ */
rtems_status_code rtems_task_create( rtems_status_code rtems_task_create(
@@ -294,7 +297,7 @@ rtems_status_code rtems_task_create(
* @param[in] node is(are) the node(s) to be searched * @param[in] node is(are) the node(s) to be searched
* @param[in] id is the pointer to thread id * @param[in] id is the pointer to thread 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 * error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will * source of the error. If successful, the id will
* be filled in with the thread id. * be filled in with the thread id.
@@ -314,7 +317,7 @@ rtems_status_code rtems_task_ident(
* *
* @param[in] id is the thread id * @param[in] id is the thread id
* *
* @return This method returns RTEMS_SUCCESSFUL if there was not an * @retval This method returns RTEMS_SUCCESSFUL if there was not an
* error and id is not the requesting thread. Status code is * error and id is not the requesting thread. Status code is
* returned indicating the source of the error. Nothing * returned indicating the source of the error. Nothing
* is returned if id is the requesting thread (always succeeds). * is returned if id is the requesting thread (always succeeds).
@@ -334,7 +337,7 @@ rtems_status_code rtems_task_delete(
* @param[in] notepad is the notepad number * @param[in] notepad is the notepad number
* @param[out] note is the pointer to note * @param[out] note is the pointer to note
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_task_get_note( rtems_status_code rtems_task_get_note(
rtems_id id, rtems_id id,
@@ -375,7 +378,7 @@ rtems_status_code rtems_task_set_note(
* @param[in] mask is the mask * @param[in] mask is the mask
* @param[in] previous_mode_set is the address of previous mode set * @param[in] previous_mode_set is the address of previous mode set
* *
* @return RTEMS_SUCCESSFUL and previous_mode_set filled in with the * @retval RTEMS_SUCCESSFUL and previous_mode_set filled in with the
* previous mode set * previous mode set
*/ */
rtems_status_code rtems_task_mode( rtems_status_code rtems_task_mode(
@@ -394,7 +397,7 @@ rtems_status_code rtems_task_mode(
* @param[in] id is the thread id * @param[in] id is the thread id
* @param[in] arg is the thread argument * @param[in] arg is the thread argument
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_task_restart( rtems_status_code rtems_task_restart(
rtems_id id, rtems_id id,
@@ -410,7 +413,7 @@ rtems_status_code rtems_task_restart(
* *
* @param[in] id is the thread id * @param[in] id is the thread 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -426,7 +429,7 @@ rtems_status_code rtems_task_suspend(
* *
* @param[in] id is the thread id * @param[in] id is the thread 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 * error. Otherwise, a status code is returned indicating the
* source of the error. * source of the error.
*/ */
@@ -446,7 +449,7 @@ rtems_status_code rtems_task_resume(
* @param[in] new_priority is the thread to extract * @param[in] new_priority is the thread to extract
* @param[in] old_priority is the thread to extract * @param[in] old_priority is the thread to extract
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* and *old_priority filled in with the previous previous priority * and *old_priority filled in with the previous previous priority
*/ */
rtems_status_code rtems_task_set_priority( rtems_status_code rtems_task_set_priority(
@@ -479,7 +482,7 @@ rtems_status_code rtems_task_start(
* *
* @param[in] time_buffer is the pointer to the time and date structure * @param[in] time_buffer is the pointer to the time and date structure
* *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/ */
rtems_status_code rtems_task_wake_when( rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer rtems_time_of_day *time_buffer
@@ -493,7 +496,7 @@ rtems_status_code rtems_task_wake_when(
* ticks have occurred. * ticks have occurred.
* *
* @param[in] ticks is the number of ticks to wait * @param[in] ticks is the number of ticks to wait
* @return RTEMS_SUCCESSFUL * @retval RTEMS_SUCCESSFUL
*/ */
rtems_status_code rtems_task_wake_after( rtems_status_code rtems_task_wake_after(
rtems_interval ticks rtems_interval ticks

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

@@ -1,9 +1,10 @@
/** /**
* @file * @file
* *
* @ingroup ClassicRTEMS * @defgroup ClassicTypes Types
* *
* @brief Types used by the Classic API. * @ingroup ClassicRTEMS
* @brief Types used by Classic API.
*/ */
/* COPYRIGHT (c) 1989-2009. /* COPYRIGHT (c) 1989-2009.