diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/signalmp.h | 65 |
1 files changed, 26 insertions, 39 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h index a706beae80..bf359473cd 100644 --- a/cpukit/rtems/include/rtems/rtems/signalmp.h +++ b/cpukit/rtems/include/rtems/rtems/signalmp.h @@ -1,12 +1,11 @@ /** * @file rtems/rtems/signalmp.h - */ - -/* + * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Signal 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 @@ -29,21 +28,26 @@ extern "C" { #include <rtems/score/thread.h> #include <rtems/score/watchdog.h> -/* +/** + * @defgroup ClassicSignalMP Classic API Signal MP Support + * + * This encapsulates functionality which XXX + */ +/**{*/ + +/** * The following enumerated type defines the list of * remote signal operations. */ - typedef enum { SIGNAL_MP_SEND_REQUEST = 0, SIGNAL_MP_SEND_RESPONSE = 1 } Signal_MP_Remote_operations; -/* +/** * The following data structure defines the packet used to perform * remote signal operations. */ - typedef struct { rtems_packet_prefix Prefix; Signal_MP_Remote_operations operation; @@ -51,9 +55,7 @@ typedef struct { } Signal_MP_Packet; /* - * _Signal_MP_Send_process_packet - * - * DESCRIPTION: + * @brief Signal_MP_Send_process_packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. @@ -62,53 +64,41 @@ typedef struct { * packets to be sent by this manager. */ -/* - * _Signal_MP_Send_request_packet - * - * DESCRIPTION: +/** + * @brief Signal_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 _Signal_MP_Send_request_packet ( Signal_MP_Remote_operations operation, Objects_Id task_id, rtems_signal_set signal_in ); -/* - * _Signal_MP_Send_response_packet - * - * DESCRIPTION: +/** + * @brief Signal_MP_Send_response_packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. */ - void _Signal_MP_Send_response_packet ( Signal_MP_Remote_operations operation, Thread_Control *the_thread ); -/* - * - * _Signal_MP_Process_packet - * - * DESCRIPTION: +/** + * @brief Signal_MP_Process_packet * * This routine performs the actions specific to this package for * the request from another node. */ - void _Signal_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ); /* - * _Signal_MP_Send_object_was_deleted - * - * DESCRIPTION: + * @brief Signal_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 @@ -119,9 +109,7 @@ void _Signal_MP_Process_packet ( */ /* - * _Signal_MP_Send_extract_proxy - * - * DESCRIPTION: + * @brief Signal_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 @@ -131,19 +119,18 @@ void _Signal_MP_Process_packet ( * deleted by this manager. */ -/* - * _Signal_MP_Get_packet - * - * DESCRIPTION: +/** + * @brief Signal_MP_Get_packet * * This function is used to obtain a signal mp packet. */ - Signal_MP_Packet *_Signal_MP_Get_packet ( void ); #ifdef __cplusplus } #endif +/**@}*/ + #endif /* end of file */ |