diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 09:34:24 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-21 09:35:58 +0200 |
commit | 86b48fb09e78d756cce2329213c0a5b48662cc52 (patch) | |
tree | b4f655d28f1e79175b733bdef2bd1853f9122e03 /c-user/multiprocessing/directives.rst | |
parent | c-user: Split up fatal error manager (diff) | |
download | rtems-docs-86b48fb09e78d756cce2329213c0a5b48662cc52.tar.bz2 |
c-user: Split up multiprocessing manager
This makes it easier to automatically generate parts of the module
documentation in the future.
Update #3993.
Diffstat (limited to 'c-user/multiprocessing/directives.rst')
-rw-r--r-- | c-user/multiprocessing/directives.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/c-user/multiprocessing/directives.rst b/c-user/multiprocessing/directives.rst new file mode 100644 index 0000000..afa3244 --- /dev/null +++ b/c-user/multiprocessing/directives.rst @@ -0,0 +1,44 @@ +.. SPDX-License-Identifier: CC-BY-SA-4.0 + +.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) + +Directives +========== + +This section details the additional directives required to support RTEMS in a +multiprocessor configuration. A subsection is dedicated to each of this +manager's directives and describes the calling sequence, related constants, +usage, and status codes. + +.. raw:: latex + + \clearpage + +.. index:: announce arrival of package +.. index:: rtems_multiprocessing_announce + +.. _rtems_multiprocessing_announce: + +MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet +----------------------------------------------------------- + +CALLING SEQUENCE: + .. code-block:: c + + void rtems_multiprocessing_announce( void ); + +DIRECTIVE STATUS CODES: + NONE + +DESCRIPTION: + 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 multiprocessor configurations. + +NOTES: + This directive is typically called from an ISR. + + This directive will almost certainly cause the calling task to be + preempted. + + This directive does not generate activity on remote nodes. |