diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-06-06 18:03:45 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-06-06 18:03:45 +0000 |
commit | 8c8fd64a704ccd5958a6a426771ea533c4eb8744 (patch) | |
tree | 0ef8fdc436a28740125d38b12a9fe39213dc5486 /cpukit/rtems/include/rtems/rtems/dpmem.h | |
parent | 2008-06-06 Joel Sherrill <joel.sherrill@OARcorp.com> (diff) | |
download | rtems-8c8fd64a704ccd5958a6a426771ea533c4eb8744.tar.bz2 |
2008-06-06 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/clock.h,
rtems/include/rtems/rtems/config.h,
rtems/include/rtems/rtems/dpmem.h,
rtems/include/rtems/rtems/eventset.h,
rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/part.h,
rtems/include/rtems/rtems/ratemon.h,
rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/sem.h,
rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
rtems/include/rtems/rtems/types.h, rtems/src/ratemonperiod.c: Improve
Classic API Doxygen.
Diffstat (limited to '')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/dpmem.h | 13 |
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; /** |