diff options
Diffstat (limited to 'cpukit/rtems/src')
| -rw-r--r-- | cpukit/rtems/src/clockgettickssinceboot.c | 9 | ||||
| -rw-r--r-- | cpukit/rtems/src/clocktodvalidate.c | 25 | ||||
| -rw-r--r-- | cpukit/rtems/src/dpmeminternal2external.c | 27 | ||||
| -rw-r--r-- | cpukit/rtems/src/msgqreceive.c | 28 | ||||
| -rw-r--r-- | cpukit/rtems/src/partdelete.c | 25 | ||||
| -rw-r--r-- | cpukit/rtems/src/ratemon.c | 24 | ||||
| -rw-r--r-- | cpukit/rtems/src/ratemondelete.c | 22 | ||||
| -rw-r--r-- | cpukit/rtems/src/ratemongetstatus.c | 25 | ||||
| -rw-r--r-- | cpukit/rtems/src/ratemonident.c | 25 | ||||
| -rw-r--r-- | cpukit/rtems/src/ratemonreportstatistics.c | 17 | ||||
| -rw-r--r-- | cpukit/rtems/src/regiongetfreeinfo.c | 27 | ||||
| -rw-r--r-- | cpukit/rtems/src/rtemsobjectapimaximumclass.c | 9 | ||||
| -rw-r--r-- | cpukit/rtems/src/rtemsobjectgetapiname.c | 9 | ||||
| -rw-r--r-- | cpukit/rtems/src/semobtain.c | 38 | ||||
| -rw-r--r-- | cpukit/rtems/src/taskmode.c | 25 | ||||
| -rw-r--r-- | cpukit/rtems/src/taskvariableadd.c | 16 | ||||
| -rw-r--r-- | cpukit/rtems/src/timerdelete.c | 23 | ||||
| -rw-r--r-- | cpukit/rtems/src/timerfireafter.c | 26 | ||||
| -rw-r--r-- | cpukit/rtems/src/workspace.c | 15 |
19 files changed, 133 insertions, 282 deletions
diff --git a/cpukit/rtems/src/clockgettickssinceboot.c b/cpukit/rtems/src/clockgettickssinceboot.c index 96a1c5e9a8..cfd91b5c57 100644 --- a/cpukit/rtems/src/clockgettickssinceboot.c +++ b/cpukit/rtems/src/clockgettickssinceboot.c @@ -1,6 +1,11 @@ -/* - * Clock Manager - Get Ticks Since Boot +/** + * @file * + * @brief Obtain Ticks Since Boot + * @ingroup ClassicClock + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/clocktodvalidate.c b/cpukit/rtems/src/clocktodvalidate.c index 7aa854cd81..a56b1df56b 100644 --- a/cpukit/rtems/src/clocktodvalidate.c +++ b/cpukit/rtems/src/clocktodvalidate.c @@ -1,7 +1,11 @@ -/* - * Time of Day (TOD) Handler -- Validate Classic TOD - * +/** + * @file * + * @brief TOD Validate + * @ingroup ClassicClock + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -29,21 +33,6 @@ const uint32_t _TOD_Days_per_month[ 2 ][ 13 ] = { { 0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 } }; -/* - * _TOD_Validate - * - * This kernel routine checks the validity of a date and time structure. - * - * Input parameters: - * the_tod - pointer to a time and date structure - * - * Output parameters: - * true - if the date, time, and tick are valid - * false - if the the_tod is invalid - * - * NOTE: This routine only works for leap-years through 2099. - */ - bool _TOD_Validate( const rtems_time_of_day *the_tod ) diff --git a/cpukit/rtems/src/dpmeminternal2external.c b/cpukit/rtems/src/dpmeminternal2external.c index 6e61566f43..a6c8d833ae 100644 --- a/cpukit/rtems/src/dpmeminternal2external.c +++ b/cpukit/rtems/src/dpmeminternal2external.c @@ -1,6 +1,11 @@ -/* - * Dual Port Memory Manager +/** + * @file * + * @brief RTEMS Port Internal to External + * @ingroup ClassicDPMEM + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -22,24 +27,6 @@ #include <rtems/score/thread.h> #include <rtems/rtems/dpmem.h> -/* - * rtems_port_internal_to_external - * - * This directive converts an internal dual-ported memory address to an - * external dual-ported memory address. If the given internal address - * is an invalid dual-ported address, then the external address is set - * to the given internal address. - * - * Input parameters: - * id - id of dual-ported memory object - * internal - internal address to set - * external - pointer to external address - * - * Output parameters: - * external - external address - * RTEMS_SUCCESSFUL - always succeeds - */ - rtems_status_code rtems_port_internal_to_external( rtems_id id, void *internal, diff --git a/cpukit/rtems/src/msgqreceive.c b/cpukit/rtems/src/msgqreceive.c index 00ed6c2eba..6be06ad67c 100644 --- a/cpukit/rtems/src/msgqreceive.c +++ b/cpukit/rtems/src/msgqreceive.c @@ -1,7 +1,11 @@ -/* - * Message Queue Manager - * +/** + * @file * + * @brief RTEMS Message Queue Receive + * @ingroup ClassicMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -32,24 +36,6 @@ #include <rtems/rtems/options.h> #include <rtems/rtems/support.h> -/* - * rtems_message_queue_receive - * - * This directive dequeues a message from the designated message queue - * and copies it into the requesting thread's buffer. - * - * Input parameters: - * id - queue id - * buffer - pointer to message buffer - * size - size of message receive - * option_set - options on receive - * timeout - number of ticks to wait - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_message_queue_receive( rtems_id id, void *buffer, diff --git a/cpukit/rtems/src/partdelete.c b/cpukit/rtems/src/partdelete.c index 6cae308b13..6aeee4e422 100644 --- a/cpukit/rtems/src/partdelete.c +++ b/cpukit/rtems/src/partdelete.c @@ -1,7 +1,11 @@ -/* - * Partition Manager - * +/** + * @file * + * @brief RTEMS Delete Partition + * @ingroup ClassicPart + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -23,21 +27,6 @@ #include <rtems/score/thread.h> #include <rtems/score/sysstate.h> -/* - * rtems_partition_delete - * - * This directive allows a thread to delete a partition specified by - * the partition identifier, provided that none of its buffers are - * still allocated. - * - * Input parameters: - * id - partition id - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_partition_delete( rtems_id id ) diff --git a/cpukit/rtems/src/ratemon.c b/cpukit/rtems/src/ratemon.c index d2eba801da..d96a9b0612 100644 --- a/cpukit/rtems/src/ratemon.c +++ b/cpukit/rtems/src/ratemon.c @@ -1,7 +1,11 @@ -/* - * Rate Monotonic Manager - * +/** + * @file * + * @brief Rate Monotonic Manager Initialization + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -23,20 +27,6 @@ #include <rtems/rtems/ratemon.h> #include <rtems/score/thread.h> -/* - * _Rate_monotonic_Manager_initialization - * - * This routine initializes all Rate Monotonic Manager related - * data structures. - * - * Input parameters: NONE - * - * Output parameters: NONE - * - * NOTE: The Rate Monotonic Manager is built on top of the Watchdog - * Handler. - */ - void _Rate_monotonic_Manager_initialization(void) { _Objects_Initialize_information( diff --git a/cpukit/rtems/src/ratemondelete.c b/cpukit/rtems/src/ratemondelete.c index 751c7f53d8..15498ea833 100644 --- a/cpukit/rtems/src/ratemondelete.c +++ b/cpukit/rtems/src/ratemondelete.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Delete a Period +/** + * @file * + * @brief RTEMS Delete Rate Monotonic + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -21,19 +26,6 @@ #include <rtems/rtems/ratemon.h> #include <rtems/score/thread.h> -/* - * rtems_rate_monotonic_delete - * - * This directive allows a thread to delete a rate monotonic timer. - * - * Input parameters: - * id - rate monotonic id - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_rate_monotonic_delete( rtems_id id ) diff --git a/cpukit/rtems/src/ratemongetstatus.c b/cpukit/rtems/src/ratemongetstatus.c index 73c59ee121..5d0d584063 100644 --- a/cpukit/rtems/src/ratemongetstatus.c +++ b/cpukit/rtems/src/ratemongetstatus.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Get Status +/** + * @file * + * @brief RTEMS Rate Monotonic Get Status + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -25,22 +30,6 @@ #include <rtems/score/timespec.h> #endif -/* - * rtems_rate_monotonic_get_status - * - * This directive allows a thread to obtain status information on a - * period. - * - * Input parameters: - * id - rate monotonic id - * status - pointer to status control block - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - * - */ - rtems_status_code rtems_rate_monotonic_get_status( rtems_id id, rtems_rate_monotonic_period_status *status diff --git a/cpukit/rtems/src/ratemonident.c b/cpukit/rtems/src/ratemonident.c index 35e4195e09..def958060d 100644 --- a/cpukit/rtems/src/ratemonident.c +++ b/cpukit/rtems/src/ratemonident.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Name to Id Lookup +/** + * @file * + * @brief RTEMS Rate Monotonic Name to Id + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -21,22 +26,6 @@ #include <rtems/rtems/ratemon.h> #include <rtems/score/thread.h> -/* - * rtems_rate_monotonic_ident - * - * This directive returns the system ID associated with - * the rate monotonic period name. - * - * Input parameters: - * name - user defined period name - * id - pointer to period id - * - * Output parameters: - * *id - region id - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_rate_monotonic_ident( rtems_name name, rtems_id *id diff --git a/cpukit/rtems/src/ratemonreportstatistics.c b/cpukit/rtems/src/ratemonreportstatistics.c index c94171c107..daf5fb5c7f 100644 --- a/cpukit/rtems/src/ratemonreportstatistics.c +++ b/cpukit/rtems/src/ratemonreportstatistics.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Report Statistics for All Periods +/** + * @file * + * @brief RTEMS Report Rate Monotonic Statistics + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -28,14 +33,6 @@ #define NANOSECONDS_FMT "%06" PRId32 #endif -/* - * This directive allows a thread to print the statistics information - * on ALL period instances which have non-zero counts using printk. - * - * The implementation of this directive straddles the fence between - * inside and outside of RTEMS. It is presented as part of the Manager - * but actually uses other services of the Manager. - */ void rtems_rate_monotonic_report_statistics_with_plugin( void *context, rtems_printk_plugin_t print diff --git a/cpukit/rtems/src/regiongetfreeinfo.c b/cpukit/rtems/src/regiongetfreeinfo.c index 52b7135f75..bd16b0ed4b 100644 --- a/cpukit/rtems/src/regiongetfreeinfo.c +++ b/cpukit/rtems/src/regiongetfreeinfo.c @@ -1,7 +1,11 @@ -/* - * Region Manager - * +/** + * @file * + * @brief RTEMS Get Region Free Information + * @ingroup ClassicRegion + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -24,23 +28,6 @@ #include <rtems/score/apimutex.h> #include <rtems/score/thread.h> -/* - * rtems_region_get_free_information - * - * This directive will return information about the free blocks - * in the region specified. Information about the used blocks - * will be returned as zero. - * - * Input parameters: - * id - region id - * the_info - pointer to region information block - * - * Output parameters: - * *the_info - region information block filled in - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_region_get_free_information( rtems_id id, Heap_Information_block *the_info diff --git a/cpukit/rtems/src/rtemsobjectapimaximumclass.c b/cpukit/rtems/src/rtemsobjectapimaximumclass.c index 17ad518e42..abeee0365c 100644 --- a/cpukit/rtems/src/rtemsobjectapimaximumclass.c +++ b/cpukit/rtems/src/rtemsobjectapimaximumclass.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Get Greatest Valid Class for an API +/** + * @file * + * @brief Get Highest Valid Class Value + * @ingroup ClassicClassInfo + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/rtemsobjectgetapiname.c b/cpukit/rtems/src/rtemsobjectgetapiname.c index 4976a92135..2f10ce74d6 100644 --- a/cpukit/rtems/src/rtemsobjectgetapiname.c +++ b/cpukit/rtems/src/rtemsobjectgetapiname.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Obtain Name of API +/** + * @file * + * @brief Get API Name + * @ingroup ClassicClassInfo + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/semobtain.c b/cpukit/rtems/src/semobtain.c index 2faaff0cc6..fe5710eefe 100644 --- a/cpukit/rtems/src/semobtain.c +++ b/cpukit/rtems/src/semobtain.c @@ -1,20 +1,11 @@ -/* - * Semaphore Manager - * - * DESCRIPTION: - * - * This package is the implementation of the Semaphore Manager. - * This manager utilizes standard Dijkstra counting semaphores to provide - * synchronization and mutual exclusion capabilities. - * - * Directives provided are: - * - * + create a semaphore - * + get an ID of a semaphore - * + delete a semaphore - * + acquire a semaphore - * + release a semaphore +/** + * @file * + * @brief RTEMS Obtain Semaphore + * @ingroup ClassicSem + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -47,21 +38,6 @@ #include <rtems/score/interr.h> -/* - * rtems_semaphore_obtain - * - * This directive allows a thread to acquire a semaphore. - * - * Input parameters: - * id - semaphore id - * option_set - wait option - * timeout - number of ticks to wait (0 means wait forever) - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_semaphore_obtain( rtems_id id, rtems_option option_set, diff --git a/cpukit/rtems/src/taskmode.c b/cpukit/rtems/src/taskmode.c index 9fab2265e0..63fe29c3dc 100644 --- a/cpukit/rtems/src/taskmode.c +++ b/cpukit/rtems/src/taskmode.c @@ -1,6 +1,11 @@ -/* - * RTEMS Task Manager - Change Task Mode +/** + * @file * + * @brief RTEMS Task Mode + * @ingroup ClassicTasks + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -28,22 +33,6 @@ #include <rtems/score/apiext.h> #include <rtems/score/sysstate.h> -/* - * rtems_task_mode - * - * This directive enables and disables several modes of - * execution for the requesting thread. - * - * Input parameters: - * mode_set - new mode - * mask - mask - * previous_mode_set - address of previous mode set - * - * Output: - * *previous_mode_set - previous mode set - * always return RTEMS_SUCCESSFUL; - */ - rtems_status_code rtems_task_mode( rtems_mode mode_set, rtems_mode mask, diff --git a/cpukit/rtems/src/taskvariableadd.c b/cpukit/rtems/src/taskvariableadd.c index 415fe69fa4..9a0bc3d43f 100644 --- a/cpukit/rtems/src/taskvariableadd.c +++ b/cpukit/rtems/src/taskvariableadd.c @@ -1,7 +1,11 @@ -/* - * rtems_task_variable_add - Add a per-task variable - * +/** + * @file * + * @brief RTEMS Add Task Variable + * @ingroup ClassicTasks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -18,12 +22,6 @@ #include <rtems/rtems/tasks.h> #include <rtems/score/wkspace.h> -/* - * rtems_task_variable_add - * - * This directive registers a task variable. - */ - rtems_status_code rtems_task_variable_add( rtems_id tid, void **ptr, diff --git a/cpukit/rtems/src/timerdelete.c b/cpukit/rtems/src/timerdelete.c index e7a0d15492..f25928054a 100644 --- a/cpukit/rtems/src/timerdelete.c +++ b/cpukit/rtems/src/timerdelete.c @@ -1,7 +1,11 @@ -/* - * Timer Manager - rtems_timer_delete directive - * +/** + * @file * + * @brief RTEMS Delete Timer + * @ingroup ClassicTimer + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -23,19 +27,6 @@ #include <rtems/score/tod.h> #include <rtems/score/watchdog.h> -/* - * rtems_timer_delete - * - * This directive allows a thread to delete a timer. - * - * Input parameters: - * id - timer id - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_timer_delete( rtems_id id ) diff --git a/cpukit/rtems/src/timerfireafter.c b/cpukit/rtems/src/timerfireafter.c index f823a7b35d..267c1cfd98 100644 --- a/cpukit/rtems/src/timerfireafter.c +++ b/cpukit/rtems/src/timerfireafter.c @@ -1,7 +1,11 @@ -/* - * Timer Manager - rtems_timer_fire_after directive - * +/** + * @file * + * @brief RTEMS Timer Fire After + * @ingroup ClassicTimer + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -23,22 +27,6 @@ #include <rtems/score/tod.h> #include <rtems/score/watchdog.h> -/* - * rtems_timer_fire_after - * - * This directive allows a thread to start a timer. - * - * Input parameters: - * id - timer id - * ticks - interval until routine is fired - * routine - routine to schedule - * user_data - passed as argument to routine when it is fired - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_timer_fire_after( rtems_id id, rtems_interval ticks, diff --git a/cpukit/rtems/src/workspace.c b/cpukit/rtems/src/workspace.c index 7af58978e4..38747be1bf 100644 --- a/cpukit/rtems/src/workspace.c +++ b/cpukit/rtems/src/workspace.c @@ -1,6 +1,11 @@ -/* - * Workspace Handler +/** + * @file * + * @brief RTEMS Workspace Support + * @ingroup ClassicRTEMSWorkspace + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -32,9 +37,6 @@ bool rtems_workspace_get_information( return _Protected_heap_Get_information( &_Workspace_Area, the_info ); } -/* - * _Workspace_Allocate - */ bool rtems_workspace_allocate( size_t bytes, void **pointer @@ -62,9 +64,6 @@ bool rtems_workspace_allocate( return true; } -/* - * _Workspace_Allocate - */ bool rtems_workspace_free( void *pointer ) |