summaryrefslogtreecommitdiffstats
path: root/c-user/dual_ports_memory_manager.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
committerChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
commit6c5640131fca82624f72b2bd33b5b5f46156626e (patch)
treeeca99c4c65ff8a3767a26a49f7aeca0af7eedfa0 /c-user/dual_ports_memory_manager.rst
parentAdd indexes to all documents. (diff)
downloadrtems-docs-6c5640131fca82624f72b2bd33b5b5f46156626e.tar.bz2
c-user: Fix index locations.
Update #3229.
Diffstat (limited to 'c-user/dual_ports_memory_manager.rst')
-rw-r--r--c-user/dual_ports_memory_manager.rst33
1 files changed, 17 insertions, 16 deletions
diff --git a/c-user/dual_ports_memory_manager.rst b/c-user/dual_ports_memory_manager.rst
index 18b5808..ed93482 100644
--- a/c-user/dual_ports_memory_manager.rst
+++ b/c-user/dual_ports_memory_manager.rst
@@ -4,12 +4,12 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-Dual-Ported Memory Manager
-**************************
-
.. index:: ports
.. index:: dual ported memory
+Dual-Ported Memory Manager
+**************************
+
Introduction
============
@@ -27,12 +27,13 @@ areas (DPMA). The directives provided by the dual-ported memory manager are:
- rtems_port_internal_to_external_ - Convert internal to external address
-Background
-==========
.. index:: dual ported memory, definition
.. index:: external addresses, definition
.. index:: internal addresses, definition
+Background
+==========
+
A dual-ported memory area (DPMA) is an contiguous block of RAM owned by a
particular processor but which can be accessed by other processors in the
system. The owner accesses the memory using internal addresses, while other
@@ -99,11 +100,11 @@ sequence, related constants, usage, and status codes.
\clearpage
.. _rtems_port_create:
+.. index:: create a port
+.. index:: rtems_port_create
PORT_CREATE - Create a port
---------------------------
-.. index:: create a port
-.. index:: rtems_port_create
CALLING SEQUENCE:
.. code-block:: c
@@ -152,13 +153,13 @@ NOTES:
\clearpage
.. _rtems_port_ident:
-
-PORT_IDENT - Get ID of a port
------------------------------
.. index:: get ID of a port
.. index:: obtain ID of a port
.. index:: rtems_port_ident
+PORT_IDENT - Get ID of a port
+-----------------------------
+
CALLING SEQUENCE:
.. code-block:: c
@@ -193,11 +194,11 @@ NOTES:
\clearpage
.. _rtems_port_delete:
+.. index:: delete a port
+.. index:: rtems_port_delete
PORT_DELETE - Delete a port
---------------------------
-.. index:: delete a port
-.. index:: rtems_port_delete
CALLING SEQUENCE:
.. code-block:: c
@@ -230,11 +231,11 @@ NOTES:
\clearpage
.. _rtems_port_external_to_internal:
+.. index:: convert external to internal address
+.. index:: rtems_port_external_to_internal
PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
----------------------------------------------------------------
-.. index:: convert external to internal address
-.. index:: rtems_port_external_to_internal
CALLING SEQUENCE:
.. code-block:: c
@@ -270,11 +271,11 @@ NOTES:
\clearpage
.. _rtems_port_internal_to_external:
+.. index:: convert internal to external address
+.. index:: rtems_port_internal_to_external
PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
----------------------------------------------------------------
-.. index:: convert internal to external address
-.. index:: rtems_port_internal_to_external
CALLING SEQUENCE:
.. code-block:: c