diff options
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/include/rtems/score/mppkt.h | 50 |
1 files changed, 36 insertions, 14 deletions
diff --git a/cpukit/score/include/rtems/score/mppkt.h b/cpukit/score/include/rtems/score/mppkt.h index 3c70225cc1..515d67150f 100644 --- a/cpukit/score/include/rtems/score/mppkt.h +++ b/cpukit/score/include/rtems/score/mppkt.h @@ -1,13 +1,15 @@ -/* mppkt.h +/** + * @file mppkt.h * * This package is the specification for the Packet Handler. * This handler defines the basic packet and provides * mechanisms to utilize packets based on this prefix. * Packets are the fundamental basis for messages passed between * nodes in an MP system. - * - * - * COPYRIGHT (c) 1989-1999. + */ + +/* + * COPYRIGHT (c) 1989-2004. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -20,6 +22,13 @@ #ifndef __MP_PACKET_h #define __MP_PACKET_h +/** + * @defgroup ScoreMPPacket MP Packet Handler + * + * This group contains functionality which XXX + */ +/**@{*/ + #ifdef __cplusplus extern "C" { #endif @@ -28,14 +37,13 @@ extern "C" { #include <rtems/score/priority.h> #include <rtems/score/watchdog.h> -/* +/** * The following enumerated type defines the packet classes. * - * NOTE: In general, each class corresponds to a manager + * @note In general, each class corresponds to a manager * which supports global operations. Each manager * defines the set of supported operations. */ - typedef enum { MP_PACKET_MPCI_INTERNAL = 0, MP_PACKET_TASKS = 1, @@ -47,43 +55,55 @@ typedef enum { MP_PACKET_SIGNAL = 7 } MP_packet_Classes; +/** + * XXX + */ #define MP_PACKET_CLASSES_FIRST MP_PACKET_MPCI_INTERNAL + +/** + * XXX + */ #define MP_PACKET_CLASSES_LAST MP_PACKET_SIGNAL -/* +/** * The following record contains the prefix for every packet * passed between nodes in an MP system. * - * NOTE: This structure is padded to ensure that anything following it + * @note This structure is padded to ensure that anything following it * is on a 16 byte boundary. This is the most stringent structure * alignment rule encountered yet. */ - typedef struct { + /** XXX */ MP_packet_Classes the_class; + /** XXX */ Objects_Id id; + /** XXX */ Objects_Id source_tid; + /** XXX */ Priority_Control source_priority; + /** XXX */ uint32_t return_code; + /** XXX */ uint32_t length; + /** XXX */ uint32_t to_convert; + /** XXX */ Watchdog_Interval timeout; } MP_packet_Prefix; -/* +/** * An MPCI must support packets of at least this size. */ - #define MP_PACKET_MINIMUM_PACKET_SIZE 64 -/* +/** * The following constant defines the number of uint32_t 's * in a packet which must be converted to native format in a * heterogeneous system. In packets longer than * MP_PACKET_MINIMUN_HETERO_CONVERSION uint32_t 's, some of the "extra" data * may a user message buffer which is not automatically endian swapped. */ - #define MP_PACKET_MINIMUN_HETERO_CONVERSION \ ( sizeof( MP_packet_Prefix ) / sizeof( uint32_t ) ) @@ -95,5 +115,7 @@ typedef struct { } #endif +/**@}*/ + #endif /* end of include file */ |