summaryrefslogtreecommitdiffstats
path: root/c/src/exec/rtems/inline/dpmem.inl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--c/src/exec/rtems/inline/dpmem.inl20
1 files changed, 20 insertions, 0 deletions
diff --git a/c/src/exec/rtems/inline/dpmem.inl b/c/src/exec/rtems/inline/dpmem.inl
index 829ec5ab07..4bd13bcd80 100644
--- a/c/src/exec/rtems/inline/dpmem.inl
+++ b/c/src/exec/rtems/inline/dpmem.inl
@@ -22,6 +22,10 @@
*
* _Dual_ported_memory_Allocate
*
+ * DESCRIPTION:
+ *
+ * This routine allocates a port control block from the inactive chain
+ * of free port control blocks.
*/
STATIC INLINE Dual_ported_memory_Control
@@ -35,6 +39,10 @@ STATIC INLINE Dual_ported_memory_Control
*
* _Dual_ported_memory_Free
*
+ * DESCRIPTION:
+ *
+ * This routine frees a port control block to the inactive chain
+ * of free port control blocks.
*/
STATIC INLINE void _Dual_ported_memory_Free (
@@ -48,6 +56,14 @@ STATIC INLINE void _Dual_ported_memory_Free (
*
* _Dual_ported_memory_Get
*
+ * DESCRIPTION:
+ *
+ * This function maps port IDs to port control blocks. If ID
+ * corresponds to a local port, then it returns the_port control
+ * pointer which maps to ID and location is set to OBJECTS_LOCAL.
+ * Global ports are not supported, thus if ID does not map to a
+ * local port, location is set to OBJECTS_ERROR and the_port is
+ * undefined.
*/
STATIC INLINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
@@ -62,6 +78,10 @@ STATIC INLINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
/*PAGE
*
* _Dual_ported_memory_Is_null
+ *
+ * DESCRIPTION:
+ *
+ * This function returns TRUE if the_port is NULL and FALSE otherwise.
*/
STATIC INLINE boolean _Dual_ported_memory_Is_null(