summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/dpmem.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-05 18:16:48 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-05 18:16:48 -0500
commita6500136a9f30603f7dff766d7b98766851c7204 (patch)
tree852061b300cada7facff9025868b143565058dc2 /cpukit/rtems/include/rtems/rtems/dpmem.h
parentrtems misc: Clean up Doxygen GCI Task #6 (diff)
downloadrtems-a6500136a9f30603f7dff766d7b98766851c7204.tar.bz2
rtems misc: Clean up Doxygen GCI Task #7
http://www.google-melange.com/gci/task/view/google/gci2012/7950206
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/dpmem.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/dpmem.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index e305b31823..5186fa1049 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -166,11 +166,20 @@ rtems_status_code rtems_port_external_to_internal(
);
/**
- * @brief rtems_port_internal_to_external
+ * @brief RTEMS Port Internal to External
*
* This routine implements the Port_internal_to_external directive.
* It returns the external port address which maps to the provided
- * internal port address for the specified port ID.
+ * internal port address for the specified port ID. If the given
+ * internal address is an invalid dual-ported address, then the
+ * external address is set to the given internal address.
+ *
+ * @param[in] id is the id of dual-ported memory object
+ * @param[in] internal is the internal address to set
+ * @param[in] external is the pointer to external address
+ *
+ * @return RTEMS_SUCCESSFUL and the external will be filled in
+ * with the external addresses
*/
rtems_status_code rtems_port_internal_to_external(
rtems_id id,