From 2ff425519007e153ba8b83ee72dc2e2f2eb2e81c Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Tue, 6 Dec 2016 12:03:54 +0100
Subject: Update linker set documentation

Update #2408.
Update #2790.
---
 c-user/linker_sets.rst | 95 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 93 insertions(+), 2 deletions(-)

(limited to 'c-user')

diff --git a/c-user/linker_sets.rst b/c-user/linker_sets.rst
index 498aeb6..d916c2f 100644
--- a/c-user/linker_sets.rst
+++ b/c-user/linker_sets.rst
@@ -31,6 +31,12 @@ The following macros are provided to create, populate and use linker sets.
 
 - RTEMS_LINKER_SET_SIZE_ - The linker set size in characters
 
+- RTEMS_LINKER_SET_ITEM_COUNT_ - The linker set item count
+
+- RTEMS_LINKER_SET_IS_EMPTY_ - Is the linker set empty?
+
+- RTEMS_LINKER_SET_FOREACH_ - Iterate through the linker set items
+
 - RTEMS_LINKER_ROSET_DECLARE_ - Declares a read-only linker set
 
 - RTEMS_LINKER_ROSET_ - Defines a read-only linker set
@@ -126,7 +132,7 @@ RTEMS_LINKER_SET_BEGIN - Designator of the linker set begin marker
 CALLING SEQUENCE:
     .. code-block:: c
 
-        volatile type *begin = RTEMS_LINKER_SET_BEGIN( set );
+        type *begin = RTEMS_LINKER_SET_BEGIN( set );
 
 DESCRIPTION:
     This macro generates the designator of the begin marker of the linker set
@@ -138,6 +144,14 @@ DESCRIPTION:
     The ``set`` parameter itself must be a valid C designator on which no macro
     expansion is performed.  It uniquely identifies the linker set.
 
+NOTE:
+    The compiler may try to be smart.  In general it will not work to assign linker
+    set begin and end addresses to pointer variables and treat them like
+    ordinary pointers.  The compiler may exploit the fact that actually two
+    distinct objects are involved and use this to optimize.  To avoid trouble
+    use :ref:`RTEMS_LINKER_SET_SIZE`, :ref:`RTEMS_LINKER_SET_ITEM_COUNT`,
+    :ref:`RTEMS_LINKER_SET_IS_EMPTY` and :ref:`RTEMS_LINKER_SET_FOREACH`.
+
 .. raw:: latex
 
    \clearpage
@@ -151,7 +165,7 @@ RTEMS_LINKER_SET_END - Designator of the linker set end marker
 CALLING SEQUENCE:
     .. code-block:: c
 
-        volatile type *end = RTEMS_LINKER_SET_END( set );
+        type *end = RTEMS_LINKER_SET_END( set );
 
 DESCRIPTION:
     This macro generates the designator of the end marker of the linker set
@@ -185,6 +199,83 @@ DESCRIPTION:
 
    \clearpage
 
+.. _RTEMS_LINKER_SET_ITEM_COUNT:
+
+RTEMS_LINKER_SET_ITEM_COUNT - The linker set item count
+---------------------------------------------------------
+.. index:: RTEMS_LINKER_SET_ITEM_COUNT
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        size_t item_count = RTEMS_LINKER_SET_ITEM_COUNT( set );
+
+DESCRIPTION:
+    This macro returns the item count of the linker set identified by ``set``.
+    The ``set`` parameter itself must be a valid C designator on which no macro
+    expansion is performed.  It uniquely identifies the linker set.
+
+.. raw:: latex
+
+   \clearpage
+
+.. _RTEMS_LINKER_SET_IS_EMPTY:
+
+RTEMS_LINKER_SET_IS_EMPTY - Is the linker set empty?
+---------------------------------------------------------
+.. index:: RTEMS_LINKER_SET_IS_EMPTY
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        bool is_empty = RTEMS_LINKER_SET_IS_EMPTY( set );
+
+DESCRIPTION:
+    This macro returns true if the linker set identified by ``set`` is empty,
+    otherwise returns false.  The ``set`` parameter itself must be a valid C
+    designator on which no macro expansion is performed.  It uniquely
+    identifies the linker set.
+
+.. raw:: latex
+
+   \clearpage
+
+.. _RTEMS_LINKER_SET_FOREACH:
+
+RTEMS_LINKER_SET_FOREACH - Iterate through the linker set items
+---------------------------------------------------------
+.. index:: RTEMS_LINKER_SET_FOREACH
+
+CALLING SEQUENCE:
+    .. code-block:: c
+
+        RTEMS_LINKER_RWSET( myset, int );
+
+        int count( void )
+        {
+          int *item;
+          int n;
+
+          n = 0;
+          RTEMS_LINKER_SET_FOREACH( myset, item ) {
+            n += *item;
+          }
+
+          return n;
+        }
+
+DESCRIPTION:
+    This macro generates a for loop statement which iterates through each item
+    of a linker set identified by ``set``.  The ``set`` parameter itself must
+    be a valid C designator on which no macro expansion is performed.  It
+    uniquely identifies the linker set.  The ``item`` parameter must be a
+    pointer to an item of the linker set.  It iterates through all items of the
+    linker set from begin to end.
+
+.. raw:: latex
+
+   \clearpage
+
 .. _RTEMS_LINKER_ROSET_DECLARE:
 
 RTEMS_LINKER_ROSET_DECLARE - Declares a read-only linker set
-- 
cgit v1.2.3