diff options
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/regionmp.h')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/regionmp.h | 71 |
1 files changed, 28 insertions, 43 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index 2b0eeac29a..5c4a61cd04 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -1,12 +1,11 @@ /** * @file rtems/rtems/regionmp.h - */ - -/* + * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Region 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/rtems/options.h> #include <rtems/rtems/region.h> -/* +/** + * @defgroup ClassicRegionMP Classic API Region MP Support + * + * This encapsulates functionality which XXX + */ +/**@{*/ + +/** * The following enumerated type defines the list of * remote region operations. */ - typedef enum { REGION_MP_ANNOUNCE_CREATE = 0, REGION_MP_ANNOUNCE_DELETE = 1, @@ -45,11 +50,10 @@ typedef enum { REGION_MP_RETURN_SEGMENT_RESPONSE = 6 } Region_MP_Remote_operations; -/* +/** * The following data structure defines the packet used to perform * remote region operations. */ - typedef struct { rtems_packet_prefix Prefix; Region_MP_Remote_operations operation; @@ -60,15 +64,12 @@ typedef struct { void *segment; } Region_MP_Packet; -/* - * _Region_MP_Send_process_packet - * - * DESCRIPTION: +/** + * @brief _Region_MP_Send_process_packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. */ - void _Region_MP_Send_process_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, @@ -76,15 +77,12 @@ void _Region_MP_Send_process_packet ( Objects_Id proxy_id ); -/* - * _Region_MP_Send_request_packet - * - * DESCRIPTION: +/** + * @brief _Region_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 _Region_MP_Send_request_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, @@ -94,39 +92,30 @@ rtems_status_code _Region_MP_Send_request_packet ( rtems_interval timeout ); -/* - * _Region_MP_Send_response_packet - * - * DESCRIPTION: +/** + * @brief _Region_MP_Send_response_packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. */ - void _Region_MP_Send_response_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, Thread_Control *the_thread ); -/* - * - * _Region_MP_Process_packet - * - * DESCRIPTION: +/** + * @brief _Region_MP_Process_packet * * This routine performs the actions specific to this package for * the request from another node. */ - void _Region_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ); /* - * _Region_MP_Send_object_was_deleted - * - * DESCRIPTION: + * @brief _Region_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 @@ -136,33 +125,29 @@ void _Region_MP_Process_packet ( * cannot be deleted when segments are in use. */ -/* - * _Region_MP_Send_extract_proxy - * - * DESCRIPTION: +/** + * @brief _Region_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 _Region_MP_Send_extract_proxy ( void *argument ); -/* - * _Region_MP_Get_packet - * - * DESCRIPTION: +/** + * @brief _Region_MP_Get_packet * * This function is used to obtain a region mp packet. */ - Region_MP_Packet *_Region_MP_Get_packet ( void ); #ifdef __cplusplus } #endif +/**@}*/ + #endif /* end of file */ |