diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-29 12:39:19 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 13:28:46 -0600 |
| commit | e655f7e4fae3e7f5f0b5738457c9d09d3cd6b773 (patch) | |
| tree | e54efe5495ba3e8f6359945c493718c3c7b47535 /cpukit/score/src/coremsgseize.c | |
| parent | libblock: Documentation (diff) | |
| download | rtems-e655f7e4fae3e7f5f0b5738457c9d09d3cd6b773.tar.bz2 | |
score misc: Score misc: Clean up Doxygen #5
Diffstat (limited to 'cpukit/score/src/coremsgseize.c')
| -rw-r--r-- | cpukit/score/src/coremsgseize.c | 40 |
1 files changed, 7 insertions, 33 deletions
diff --git a/cpukit/score/src/coremsgseize.c b/cpukit/score/src/coremsgseize.c index 84652d1b77..bb49810bbd 100644 --- a/cpukit/score/src/coremsgseize.c +++ b/cpukit/score/src/coremsgseize.c @@ -1,12 +1,11 @@ -/* - * CORE Message Queue Handler - * - * DESCRIPTION: - * - * This package is the implementation of the CORE Message Queue Handler. - * This core object provides task synchronization and communication functions - * via messages passed to queue objects. +/** + * @file * + * @brief Size a Message from the Message Queue + * @ingroup ScoreMessageQueue + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -28,31 +27,6 @@ #include <rtems/score/thread.h> #include <rtems/score/wkspace.h> -/* - * _CORE_message_queue_Seize - * - * This kernel routine dequeues a message, copies the message buffer to - * a given destination buffer, and frees the message buffer to the - * inactive message pool. The thread will be blocked if wait is true, - * otherwise an error will be given to the thread if no messages are available. - * - * Input parameters: - * the_message_queue - pointer to message queue - * id - id of object we are waitig on - * buffer - pointer to message buffer to be filled - * size_p - pointer to the size of buffer to be filled - * wait - true if wait is allowed, false otherwise - * timeout - time to wait for a message - * - * Output parameters: NONE - * - * NOTE: Dependent on BUFFER_LENGTH - * - * INTERRUPT LATENCY: - * available - * wait - */ - void _CORE_message_queue_Seize( CORE_message_queue_Control *the_message_queue, Objects_Id id, |