summaryrefslogtreecommitdiffstats
path: root/c-user/multiprocessing/directives.rst
diff options
context:
space:
mode:
Diffstat (limited to 'c-user/multiprocessing/directives.rst')
-rw-r--r--c-user/multiprocessing/directives.rst78
1 files changed, 54 insertions, 24 deletions
diff --git a/c-user/multiprocessing/directives.rst b/c-user/multiprocessing/directives.rst
index afa3244..ad7c6e2 100644
--- a/c-user/multiprocessing/directives.rst
+++ b/c-user/multiprocessing/directives.rst
@@ -1,44 +1,74 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. 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
+
+.. _MultiprocessingManagerDirectives:
+
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.
+This section details the directives of the Multiprocessing Manager. A
+subsection is dedicated to each of this manager's directives and lists the
+calling sequence, parameters, description, return values, and notes of the
+directive.
+
+.. Generated from spec:/rtems/mp/if/announce
.. raw:: latex
- \clearpage
+ \clearpage
+
+.. index:: rtems_multiprocessing_announce()
+
+.. _InterfaceRtemsMultiprocessingAnnounce:
+
+rtems_multiprocessing_announce()
+--------------------------------
+
+Announces the arrival of a packet.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+ void rtems_multiprocessing_announce( void );
+
+.. rubric:: DESCRIPTION:
-.. index:: announce arrival of package
-.. index:: rtems_multiprocessing_announce
+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.
-.. _rtems_multiprocessing_announce:
+.. rubric:: NOTES:
-MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
------------------------------------------------------------
+This directive is typically called from an :term:`ISR`.
-CALLING SEQUENCE:
- .. code-block:: c
+This directive does not generate activity on remote nodes.
- void rtems_multiprocessing_announce( void );
+.. rubric:: CONSTRAINTS:
-DIRECTIVE STATUS CODES:
- NONE
+The following constraints apply to this directive:
-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.
+* The directive may be called from within interrupt context.
-NOTES:
- This directive is typically called from an ISR.
+* The directive may be called from within device driver initialization context.
- This directive will almost certainly cause the calling task to be
- preempted.
+* The directive may be called from within task context.
- This directive does not generate activity on remote nodes.
+* The directive may unblock another task which may preempt the calling task.