summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/mp.h
blob: 614a65fe4c185f8b8d7eae12a177394fc0b557d7 (plain) (blame)
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSImplClassic
 *
 * @brief This header file defines the Multiprocessing Manager API.
 */

/*
 * Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 2008 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.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/rtems/mp/if/header */

#ifndef _RTEMS_RTEMS_MP_H
#define _RTEMS_RTEMS_MP_H

#include <rtems/score/mpci.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/mp/if/group */

/**
 * @defgroup RTEMSAPIClassicMP Multiprocessing Manager
 *
 * @ingroup RTEMSAPIClassic
 *
 * @brief The Multiprocessing Manager provides support for heterogeneous
 *   multiprocessing systems based on message passing in a network of
 *   multiprocessing nodes.
 *
 * In multiprocessor real-time systems, new requirements, such as sharing data
 * and global resources between processors, are introduced.  This requires an
 * efficient and reliable communications vehicle which allows all processors to
 * communicate with each other as necessary.  In addition, the ramifications of
 * multiple processors affect each and every characteristic of a real-time
 * system, almost always making them more complicated.
 *
 * RTEMS addresses these issues by providing simple and flexible real-time
 * multiprocessing capabilities.  The executive easily lends itself to both
 * tightly-coupled and loosely-coupled configurations of the target system
 * hardware.  In addition, RTEMS supports systems composed of both homogeneous
 * and heterogeneous mixtures of processors and target boards.
 *
 * A major design goal of the RTEMS executive was to transcend the physical
 * boundaries of the target hardware configuration.  This goal is achieved by
 * presenting the application software with a logical view of the target system
 * where the boundaries between processor nodes are transparent.  As a result,
 * the application developer may designate objects such as tasks, queues,
 * events, signals, semaphores, and memory blocks as global objects.  These
 * global objects may then be accessed by any task regardless of the physical
 * location of the object and the accessing task.  RTEMS automatically
 * determines that the object being accessed resides on another processor and
 * performs the actions required to access the desired object.  Simply stated,
 * RTEMS allows the entire system, both hardware and software, to be viewed
 * logically as a single system.
 */

/* Generated from spec:/rtems/mp/if/announce */

/**
 * @ingroup RTEMSAPIClassicMP
 *
 * @brief Announces the arrival of a packet.
 *
 * This directive informs RTEMS that a multiprocessing communications packet
 * has arrived from another node.  This directive is called by the
 * user-provided MPCI, and is only used in multiprocessing configurations.
 *
 * @par Notes
 * @parblock
 * This directive is typically called from an ISR.
 *
 * This directive does not generate activity on remote nodes.
 * @endparblock
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within interrupt context.
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive may unblock a task.  This may cause the calling task to be
 *   preempted.
 * @endparblock
 */
void rtems_multiprocessing_announce( void );

/* Generated from spec:/rtems/mp/if/minimum-hetero-conversion */

/**
 * @ingroup RTEMSAPIClassicMP
 *
 * @brief This constant defines the count of uint32_t numbers in a packet which
 *   must be converted to native format in a heterogeneous system.
 *
 * In packets longer than this value, some of the extra data may be a user
 * message buffer which is not automatically endian swapped.
 */
#define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION

/* Generated from spec:/rtems/mp/if/minimum-packet-size */

/**
 * @ingroup RTEMSAPIClassicMP
 *
 * @brief This constant defines the minimum packet size which must be supported
 *   by the MPCI.
 */
#define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_RTEMS_MP_H */