diff options
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/taskmp.h')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/taskmp.h | 75 |
1 files changed, 30 insertions, 45 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h index 9adae0ced6..03e1dfbfb8 100644 --- a/cpukit/rtems/include/rtems/rtems/taskmp.h +++ b/cpukit/rtems/include/rtems/rtems/taskmp.h @@ -1,12 +1,11 @@ /** * @file rtems/rtems/taskmp.h - */ - -/* + * * This include file contains all the constants and structures associated * with the multiprocessing support in the task 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 @@ -19,10 +18,6 @@ #ifndef _RTEMS_RTEMS_TASKMP_H #define _RTEMS_RTEMS_TASKMP_H -#ifdef __cplusplus -extern "C" { -#endif - #include <rtems/score/mppkt.h> #include <rtems/score/object.h> #include <rtems/rtems/options.h> @@ -30,11 +25,20 @@ extern "C" { #include <rtems/rtems/tasks.h> #include <rtems/score/thread.h> -/* +/** + * @defgroup ClassicTaskMP Classic API Task MP Support + * + * This encapsulates functionality which XXX + */ +/**@{*/ + +#ifdef __cplusplus +extern "C" { +#endif +/** * The following enumerated type defines the list of * remote task operations. */ - typedef enum { RTEMS_TASKS_MP_ANNOUNCE_CREATE = 0, RTEMS_TASKS_MP_ANNOUNCE_DELETE = 1, @@ -50,11 +54,10 @@ typedef enum { RTEMS_TASKS_MP_SET_NOTE_RESPONSE = 11 } RTEMS_tasks_MP_Remote_operations; -/* +/** * The following data structure defines the packet used to perform * remote task operations. */ - typedef struct { rtems_packet_prefix Prefix; RTEMS_tasks_MP_Remote_operations operation; @@ -64,30 +67,24 @@ typedef struct { uint32_t note; } RTEMS_tasks_MP_Packet; -/* - * _RTEMS_tasks_MP_Send_process_packet - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_MP_Send_process_packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. */ - void _RTEMS_tasks_MP_Send_process_packet ( RTEMS_tasks_MP_Remote_operations operation, Objects_Id task_id, rtems_name name ); -/* - * _RTEMS_tasks_MP_Send_request_packet - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_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 _RTEMS_tasks_MP_Send_request_packet ( RTEMS_tasks_MP_Remote_operations operation, Objects_Id task_id, @@ -96,38 +93,29 @@ rtems_status_code _RTEMS_tasks_MP_Send_request_packet ( uint32_t note ); -/* - * _RTEMS_tasks_MP_Send_response_packet - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_MP_Send_response_packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. */ - void _RTEMS_tasks_MP_Send_response_packet ( RTEMS_tasks_MP_Remote_operations operation, Thread_Control *the_thread ); -/* - * - * _RTEMS_tasks_MP_Process_packet - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_MP_Process_packet * * This routine performs the actions specific to this package for * the request from another node. */ - void _RTEMS_tasks_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ); -/* - * _RTEMS_tasks_MP_Send_object_was_deleted - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_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 @@ -140,8 +128,6 @@ void _RTEMS_tasks_MP_Process_packet ( /* * _RTEMS_tasks_MP_Send_extract_proxy * - * DESCRIPTION: - * * 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. @@ -151,19 +137,18 @@ void _RTEMS_tasks_MP_Process_packet ( * */ -/* - * _RTEMS_tasks_MP_Get_packet - * - * DESCRIPTION: +/** + * @brief _RTEMS_tasks_MP_Get_packet * * This function is used to obtain a task mp packet. */ - RTEMS_tasks_MP_Packet *_RTEMS_tasks_MP_Get_packet ( void ); #ifdef __cplusplus } #endif +/**@}*/ + #endif /* end of file */ |