summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/dpmem.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/dpmem.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/dpmem.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 5a16107471..5a862c6984 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -50,7 +50,8 @@ extern "C" {
/**
* @defgroup ClassicDPMEM Classic API Dual Ported Memory
*
- * This encapsulates functionality which XXX
+ * This encapsulates functionality related to the
+ * Classic API Dual Ported Memory Manager.
*/
/**@{*/
@@ -60,10 +61,14 @@ extern "C" {
* all information required to support the port related operations.
*/
typedef struct {
+ /** This field is the object management portion of a Port instance. */
Objects_Control Object;
- void *internal_base; /* base internal address */
- void *external_base; /* base external address */
- uint32_t length; /* length of dual-ported area */
+ /** This field is the base internal address of the port. */
+ void *internal_base;
+ /** This field is the base external address of the port. */
+ void *external_base;
+ /** This field is the length of dual-ported area of the port. */
+ uint32_t length;
} Dual_ported_memory_Control;
/**