summaryrefslogtreecommitdiffstats
path: root/c-user/dual-ported-memory/introduction.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-21 14:52:45 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-04-21 19:47:34 +0200
commit03fc1d6514ca76e3e694545e5ba16e59abb1541b (patch)
tree7079659f50e1a721d273538c50717de0f131f257 /c-user/dual-ported-memory/introduction.rst
parentc-user: Generate multiprocessing manager docs (diff)
downloadrtems-docs-03fc1d6514ca76e3e694545e5ba16e59abb1541b.tar.bz2
c-user: Generate dual-ported memory manager docs
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.
Diffstat (limited to '')
-rw-r--r--c-user/dual-ported-memory/introduction.rst43
1 files changed, 36 insertions, 7 deletions
diff --git a/c-user/dual-ported-memory/introduction.rst b/c-user/dual-ported-memory/introduction.rst
index 752a162..fd7cc8e 100644
--- a/c-user/dual-ported-memory/introduction.rst
+++ b/c-user/dual-ported-memory/introduction.rst
@@ -1,20 +1,49 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. Copyright (C) 2020, 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/dpmem/if/group
+
+.. _DualPortedMemoryManagerIntroduction:
+
Introduction
============
-The dual-ported memory manager provides a mechanism for converting addresses
+.. The following list was generated from:
+.. spec:/rtems/dpmem/if/create
+.. spec:/rtems/dpmem/if/ident
+.. spec:/rtems/dpmem/if/delete
+.. spec:/rtems/dpmem/if/external-to-internal
+.. spec:/rtems/dpmem/if/internal-to-external
+
+The Dual-Ported Memory Manager provides a mechanism for converting addresses
between internal and external representations for multiple dual-ported memory
-areas (DPMA). The directives provided by the dual-ported memory manager are:
+areas (DPMA). The directives provided by the Dual-Ported Memory Manager are:
-- :ref:`rtems_port_create`
+* :ref:`InterfaceRtemsPortCreate` - Creates a port.
-- :ref:`rtems_port_ident`
+* :ref:`InterfaceRtemsPortIdent` - Identifies a port by the object name.
-- :ref:`rtems_port_delete`
+* :ref:`InterfaceRtemsPortDelete` - Deletes the port.
-- :ref:`rtems_port_external_to_internal`
+* :ref:`InterfaceRtemsPortExternalToInternal` - Converts the external address
+ to the internal address.
-- :ref:`rtems_port_internal_to_external`
+* :ref:`InterfaceRtemsPortInternalToExternal` - Converts the internal address
+ to the external address.