1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSScoreMPPacket
*
* @brief This header file provides the interfaces of the
* @ref RTEMSScoreMPPacket.
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTEMS_SCORE_MPPKT_H
#define _RTEMS_SCORE_MPPKT_H
#include <rtems/score/object.h>
#include <rtems/score/priority.h>
#include <rtems/score/watchdogticks.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup RTEMSScoreMPPacket Multiprocessing (MP) Packet Handler
*
* @ingroup RTEMSScore
*
* @brief This group contains the Multiprocessing (MP) Packet Handler
* implementation.
*
* This handler encapsulates the primary definition of MPCI packets. This
* handler defines the part of the packet that is common to all remote
* operations. It 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.
*
* @{
*/
/**
* The following enumerated type defines the packet classes.
*
* @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,
MP_PACKET_MESSAGE_QUEUE = 2,
MP_PACKET_SEMAPHORE = 3,
MP_PACKET_PARTITION = 4,
MP_PACKET_REGION = 5,
MP_PACKET_EVENT = 6,
MP_PACKET_SIGNAL = 7
} MP_packet_Classes;
/**
* This constant defines the first entry in the MP_packet_Classes enumeration.
*/
#define MP_PACKET_CLASSES_FIRST MP_PACKET_MPCI_INTERNAL
/**
* This constant defines the last entry in the MP_packet_Classes enumeration.
*/
#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
* is on a 16 byte boundary. This is the most stringent structure
* alignment rule encountered yet.
*/
typedef struct {
/** This field indicates the API class of the operation being performed. */
MP_packet_Classes the_class;
/** This field is the id of the object to be acted upon. */
Objects_Id id;
/** This field is the ID of the originating thread. */
Objects_Id source_tid;
/** This field is the priority of the originating thread. */
uint32_t source_priority;
/** This field is where the status of the operation will be returned. */
uint32_t return_code;
/** This field is the length of the data following the prefix. */
uint32_t length;
/** This field is the length of the data which required network conversion. */
uint32_t to_convert;
/** This field is the requested timeout for this operation. */
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 ) )
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
