diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/msgmp.h | 73 |
1 files changed, 29 insertions, 44 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h index 2b9b41da15..ea9568f639 100644 --- a/cpukit/rtems/include/rtems/rtems/msgmp.h +++ b/cpukit/rtems/include/rtems/rtems/msgmp.h @@ -1,12 +1,11 @@ /** * @file rtems/rtems/msgmp.h - */ - -/* + * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Message Manager. - * - * COPYRIGHT (c) 1989-1999. + */ + +/* COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -30,11 +29,17 @@ extern "C" { #include <rtems/score/thread.h> #include <rtems/score/watchdog.h> -/* +/** + * @defgroup ClassicMsgMP Classic API Message Queue MP Support + * + * This encapsulates functionality which XXX + */ +/**{*/ + +/** * The following enumerated type defines the list of * remote message queue operations. */ - typedef enum { MESSAGE_QUEUE_MP_ANNOUNCE_CREATE = 0, MESSAGE_QUEUE_MP_ANNOUNCE_DELETE = 1, @@ -53,11 +58,10 @@ typedef enum { MESSAGE_QUEUE_MP_GET_NUMBER_PENDING_RESPONSE = 14 } Message_queue_MP_Remote_operations; -/* +/** * The following data structure defines the packet used to perform * remote message queue operations. */ - typedef struct { rtems_packet_prefix Prefix; Message_queue_MP_Remote_operations operation; @@ -70,15 +74,12 @@ typedef struct { CORE_message_queue_Buffer Buffer; } Message_queue_MP_Packet; -/* - * _Message_queue_MP_Send_process_packet - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Send_process_packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. */ - void _Message_queue_MP_Send_process_packet ( Message_queue_MP_Remote_operations operation, Objects_Id message_queue_id, @@ -86,15 +87,12 @@ void _Message_queue_MP_Send_process_packet ( Objects_Id proxy_id ); -/* - * _Message_queue_MP_Send_request_packet - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Send_request_packet * * This routine performs a remote procedure call so that a * directive operation can be initiated on another node. */ - rtems_status_code _Message_queue_MP_Send_request_packet ( Message_queue_MP_Remote_operations operation, Objects_Id message_queue_id, @@ -104,76 +102,63 @@ rtems_status_code _Message_queue_MP_Send_request_packet ( Watchdog_Interval timeout ); -/* - * _Message_queue_MP_Send_response_packet - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Send_response_packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. */ - void _Message_queue_MP_Send_response_packet ( Message_queue_MP_Remote_operations operation, Objects_Id message_queue_id, Thread_Control *the_thread ); -/* - * - * _Message_queue_MP_Process_packet +/** * - * DESCRIPTION: + @brief * _Message_queue_MP_Process_packet * * This routine performs the actions specific to this package for * the request from another node. */ - void _Message_queue_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ); -/* - * _Message_queue_MP_Send_object_was_deleted - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Send_object_was_deleted * * This routine is invoked indirectly by the thread queue * when a proxy has been removed from the thread queue and * the remote node must be informed of this. */ - void _Message_queue_MP_Send_object_was_deleted ( Thread_Control *the_proxy ); -/* - * _Message_queue_MP_Send_extract_proxy - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Send_extract_proxy * * This routine is invoked when a task is deleted and it * has a proxy which must be removed from a thread queue and * the remote node must be informed of this. */ - void _Message_queue_MP_Send_extract_proxy ( void *argument ); -/* - * _Message_queue_MP_Get_packet - * - * DESCRIPTION: +/** + * @brief _Message_queue_MP_Get_packet * * This function is used to obtain a message queue mp packet. */ - Message_queue_MP_Packet *_Message_queue_MP_Get_packet ( void ); #ifdef __cplusplus } #endif +/**@}*/ + #endif /* end of file */ |