summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/region.inl
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
commit067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch)
treed04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/inline/rtems/rtems/region.inl
parent2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-067a96ad0c3b0818d71d9aaadaee4b520d940de1.tar.bz2
2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/options.h, rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h, rtems/include/rtems/rtems/ratemon.h, rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/regionmp.h, rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h, rtems/include/rtems/rtems/signalmp.h, rtems/include/rtems/rtems/status.h, rtems/include/rtems/rtems/support.h, rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl, rtems/inline/rtems/rtems/attr.inl, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/dpmem.inl, rtems/inline/rtems/rtems/event.inl, rtems/inline/rtems/rtems/eventset.inl, rtems/inline/rtems/rtems/message.inl, rtems/inline/rtems/rtems/modes.inl, rtems/inline/rtems/rtems/options.inl, rtems/inline/rtems/rtems/part.inl, rtems/inline/rtems/rtems/ratemon.inl, rtems/inline/rtems/rtems/region.inl, rtems/inline/rtems/rtems/sem.inl, rtems/inline/rtems/rtems/status.inl, rtems/inline/rtems/rtems/support.inl, rtems/inline/rtems/rtems/tasks.inl, rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API header files to Doxygen. * rtems/Doxyfile: New file.
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/region.inl62
1 files changed, 21 insertions, 41 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/region.inl b/cpukit/rtems/inline/rtems/rtems/region.inl
index 412efec203..efc77f8db2 100644
--- a/cpukit/rtems/inline/rtems/rtems/region.inl
+++ b/cpukit/rtems/inline/rtems/rtems/region.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/region.inl
- */
-
-/*
+ *
* This file contains the macro implementation of the inlined
* routines from the Region Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
#ifndef _RTEMS_RTEMS_REGION_INL
#define _RTEMS_RTEMS_REGION_INL
-/*PAGE
- *
- * _Region_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicRegion
+ * @{
+ */
+
+/**
+ * @brief Region_Allocate
*
* This function allocates a region control block from
* the inactive chain of free region control blocks.
*/
-
RTEMS_INLINE_ROUTINE Region_Control *_Region_Allocate( void )
{
return (Region_Control *) _Objects_Allocate( &_Region_Information );
}
-/*PAGE
- *
- * _Region_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Free
*
* This routine frees a region control block to the
* inactive chain of free region control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Region_Free (
Region_Control *the_region
)
@@ -51,11 +47,8 @@ RTEMS_INLINE_ROUTINE void _Region_Free (
_Objects_Free( &_Region_Information, &the_region->Object );
}
-/*PAGE
- *
- * _Region_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Get
*
* This function maps region IDs to region control blocks.
* If ID corresponds to a local region, then it returns
@@ -63,7 +56,6 @@ RTEMS_INLINE_ROUTINE void _Region_Free (
* is set to OBJECTS_LOCAL. Otherwise, location is set
* to OBJECTS_ERROR and the_region is undefined.
*/
-
RTEMS_INLINE_ROUTINE Region_Control *_Region_Get (
Objects_Id id,
Objects_Locations *location
@@ -73,17 +65,13 @@ RTEMS_INLINE_ROUTINE Region_Control *_Region_Get (
_Objects_Get_no_protection( &_Region_Information, id, location );
}
-/*PAGE
- *
- * _Region_Allocate_segment
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Allocate_segment
*
* This function attempts to allocate a segment from the_region.
* If successful, it returns the address of the allocated segment.
* Otherwise, it returns NULL.
*/
-
RTEMS_INLINE_ROUTINE void *_Region_Allocate_segment (
Region_Control *the_region,
uint32_t size
@@ -92,15 +80,11 @@ RTEMS_INLINE_ROUTINE void *_Region_Allocate_segment (
return _Heap_Allocate( &the_region->Memory, size );
}
-/*PAGE
- *
- * _Region_Free_segment
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Free_segment
*
* This function frees the_segment to the_region.
*/
-
RTEMS_INLINE_ROUTINE boolean _Region_Free_segment (
Region_Control *the_region,
void *the_segment
@@ -109,15 +93,11 @@ RTEMS_INLINE_ROUTINE boolean _Region_Free_segment (
return _Heap_Free( &the_region->Memory, the_segment );
}
-/*PAGE
- *
- * _Region_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Is_null
*
* This function returns TRUE if the_region is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Region_Is_null (
Region_Control *the_region
)