diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/support.h | 72 |
1 files changed, 39 insertions, 33 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h index 8d8a85a825..220411d984 100644 --- a/cpukit/rtems/include/rtems/rtems/support.h +++ b/cpukit/rtems/include/rtems/rtems/support.h @@ -1,8 +1,11 @@ /** - * @file rtems/rtems/support.h + * @file * - * This include file contains information about support functions for - * the RTEMS API. + * @ingroup ClassicRTEMS + * + * @ingroup ClassicRTEMSWorkspace + * + * @brief Classic API support. */ /* COPYRIGHT (c) 1989-2008. @@ -25,58 +28,61 @@ extern "C" { #include <rtems/rtems/types.h> /** - * @addtogroup ClassicRTEMS - * @{ + * @addtogroup ClassicRTEMS + * + * @{ */ /** - * @brief milliseconds to microseconds - * - * This is the public milliseconds to microseconds conversion. + * @brief Returns the number of micro seconds for the milli seconds value @a _ms. */ #define RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) \ TOD_MILLISECONDS_TO_MICROSECONDS(_ms) /** - * @brief milliseconds to ticks - * - * This is the public milliseconds to ticks conversion. + * @brief Returns the number of ticks for the milli seconds value @a _ms. */ #define RTEMS_MILLISECONDS_TO_TICKS(_ms) \ (TOD_MILLISECONDS_TO_MICROSECONDS(_ms) / \ rtems_configuration_get_microseconds_per_tick()) /** - * @brief microseconds to ticks - * - * This is the public microseconds to tick conversion. + * @brief Returns the number of ticks for the micro seconds value @a _us. */ -#define RTEMS_MICROSECONDS_TO_TICKS(_ms) \ - ((_ms) / rtems_configuration_get_microseconds_per_tick()) +#define RTEMS_MICROSECONDS_TO_TICKS(_us) \ + ((_us) / rtems_configuration_get_microseconds_per_tick()) + +/** @} */ /** - * @brief get workspace information + * @defgroup ClassicRTEMSWorkspace Workspace * - * This returns information about the heap that is used as - * the RTEMS Executive Workspace. + * @ingroup ClassicRTEMS * - * @param[in] the_info + * Workspace definitions. * - * @return true if successful + * @{ + */ + +/** + * @brief Gets workspace information. + * + * Returns information about the heap that is used as the RTEMS Executive + * Workspace in @a the_info. + * + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_get_information( Heap_Information_block *the_info ); /** - * @brief allocate memory from workspace + * @brief Allocates memory from the workspace. * - * This allocates memory from the the RTEMS Executive Workspace. + * A number of @a bytes bytes will be allocated from the RTEMS Executive + * Workspace and returned in @a pointer. * - * @param[in] bytes is the number of bytes to allocate - * @param[in] pointer is the returned pointer to allocated memory - * - * @return true if successful + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_allocate( size_t bytes, @@ -84,19 +90,19 @@ bool rtems_workspace_allocate( ); /** - * @brief free memory back to the workspace - * - * This frees memory that was allocated from - * the RTEMS Executive Workspace. + * @brief Frees memory allocated from the workspace. * - * @param[in] pointer is the allocated workspace + * This frees the memory indicated by @a pointer that was allocated from the + * RTEMS Executive Workspace. * - * @return true if successful + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_free( void *pointer ); +/** @} */ + #ifndef __RTEMS_APPLICATION__ #include <rtems/rtems/support.inl> #endif |