rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-22 05:47:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Generate multiprocessing manager docs

Browse Source 
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
This commit is contained in:
Sebastian Huber 2021-04-21 13:55:27 +02:00
parent d946f307e9
commit a99562097a
2 changed files with 84 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
c-user/multiprocessing/directives.rst
View File

@ -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:: announce arrival of package
.. index:: rtems_multiprocessing_announce
.. index:: rtems_multiprocessing_announce()
.. _rtems_multiprocessing_announce:
.. _InterfaceRtemsMultiprocessingAnnounce:
MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
-----------------------------------------------------------
rtems_multiprocessing_announce()
--------------------------------
CALLING SEQUENCE:
.. code-block:: c
Announces the arrival of a packet.
void rtems_multiprocessing_announce( void );
.. rubric:: CALLING SEQUENCE:
DIRECTIVE STATUS CODES:
NONE
.. code-block:: c
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.
void rtems_multiprocessing_announce( void );
NOTES:
This directive is typically called from an ISR.
.. rubric:: DESCRIPTION:
This directive will almost certainly cause the calling task to be
preempted.
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.
This directive does not generate activity on remote nodes.
.. rubric:: NOTES:
This directive is typically called from an :term:`ISR`.
This directive does not generate activity on remote nodes.
.. rubric:: CONSTRAINTS:
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 another task which may preempt the calling task.

34
c-user/multiprocessing/introduction.rst
View File

@ -1,10 +1,36 @@
.. 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
.. Generated from spec:/rtems/mp/if/group
.. _MultiprocessingManagerIntroduction:
Introduction
============
.. The following list was generated from:
.. spec:/rtems/mp/if/announce
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
@ -28,8 +54,8 @@ 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.
both hardware and software, to be viewed logically as a single system. The
directives provided by the Multiprocessing Manager are:
The directives provided by the Manager are:
- :ref:`rtems_multiprocessing_announce`
* :ref:`InterfaceRtemsMultiprocessingAnnounce` - Announces the arrival of a
packet.