diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-04-18 15:02:20 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-04-18 15:02:20 +0000 |
commit | 067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch) | |
tree | d04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/include/rtems/rtems/eventmp.h | |
parent | 2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff) | |
download | rtems-067a96ad0c3b0818d71d9aaadaee4b520d940de1.tar.bz2 |
2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h,
rtems/include/rtems/rtems/attr.h,
rtems/include/rtems/rtems/barrier.h,
rtems/include/rtems/rtems/barriermp.h,
rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h,
rtems/include/rtems/rtems/config.h,
rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
rtems/include/rtems/rtems/eventmp.h,
rtems/include/rtems/rtems/eventset.h,
rtems/include/rtems/rtems/intr.h,
rtems/include/rtems/rtems/message.h,
rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
rtems/include/rtems/rtems/msgmp.h,
rtems/include/rtems/rtems/object.h,
rtems/include/rtems/rtems/options.h,
rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
rtems/include/rtems/rtems/ratemon.h,
rtems/include/rtems/rtems/region.h,
rtems/include/rtems/rtems/regionmp.h,
rtems/include/rtems/rtems/rtemsapi.h,
rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
rtems/include/rtems/rtems/signal.h,
rtems/include/rtems/rtems/signalmp.h,
rtems/include/rtems/rtems/status.h,
rtems/include/rtems/rtems/support.h,
rtems/include/rtems/rtems/taskmp.h,
rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
rtems/inline/rtems/rtems/attr.inl,
rtems/inline/rtems/rtems/barrier.inl,
rtems/inline/rtems/rtems/dpmem.inl,
rtems/inline/rtems/rtems/event.inl,
rtems/inline/rtems/rtems/eventset.inl,
rtems/inline/rtems/rtems/message.inl,
rtems/inline/rtems/rtems/modes.inl,
rtems/inline/rtems/rtems/options.inl,
rtems/inline/rtems/rtems/part.inl,
rtems/inline/rtems/rtems/ratemon.inl,
rtems/inline/rtems/rtems/region.inl,
rtems/inline/rtems/rtems/sem.inl,
rtems/inline/rtems/rtems/status.inl,
rtems/inline/rtems/rtems/support.inl,
rtems/inline/rtems/rtems/tasks.inl,
rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API
header files to Doxygen.
* rtems/Doxyfile: New file.
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/eventmp.h')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/eventmp.h | 67 |
1 files changed, 27 insertions, 40 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h index e3b149b7d6..2ebed71b3f 100644 --- a/cpukit/rtems/include/rtems/rtems/eventmp.h +++ b/cpukit/rtems/include/rtems/rtems/eventmp.h @@ -1,12 +1,11 @@ /** * @file rtems/rtems/eventmp.h - */ - -/* + * * This include file contains all the constants and structures associated * with the Multiprocessing Support in the Event 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 ClassicEventMP Classic API Event MP Support + * + * This encapsulates functionality which XXX + */ +/**@{*/ + +/** * The following enumerated type defines the list of * remote event operations. */ - typedef enum { EVENT_MP_SEND_REQUEST = 0, EVENT_MP_SEND_RESPONSE = 1 } Event_MP_Remote_operations; -/* +/** * The following data structure defines the packet used to perform * remote event operations. */ - typedef struct { rtems_packet_prefix Prefix; Event_MP_Remote_operations operation; @@ -51,64 +55,50 @@ typedef struct { } Event_MP_Packet; /* - * _Event_MP_Send_process_packet - * - * DESCRIPTION: + * @brief Event_MP_Send_process_packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. * - * This routine is not needed since there are no process + * @note This routine is not needed since there are no process * packets to be sent by this manager. */ -/* - * _Event_MP_Send_request_packet - * - * DESCRIPTION: +/** + * @brief Event_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 _Event_MP_Send_request_packet ( Event_MP_Remote_operations operation, Objects_Id event_id, rtems_event_set event_in ); -/* - * _Event_MP_Send_response_packet - * - * DESCRIPTION: +/** + * @brief Event_MP_Send_response_packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. */ - void _Event_MP_Send_response_packet ( Event_MP_Remote_operations operation, Thread_Control *the_thread ); -/* - * - * _Event_MP_Process_packet - * - * DESCRIPTION: +/** + * @brief Event_MP_Process_packet * * This routine performs the actions specific to this package for * the request from another node. */ - void _Event_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ); /* - * _Event_MP_Send_object_was_deleted - * - * DESCRIPTION: + * @brief Event_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 _Event_MP_Process_packet ( */ /* - * _Event_MP_Send_extract_proxy - * - * DESCRIPTION: + * @brief Event_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 _Event_MP_Process_packet ( * deleted by this manager. */ -/* - * _Event_MP_Get_packet - * - * DESCRIPTION: +/** + * @brief Event_MP_Get_packet * * This function is used to obtain a event mp packet. */ - Event_MP_Packet *_Event_MP_Get_packet ( void ); #ifdef __cplusplus } #endif +/**@}*/ + #endif /* end of file */ |