summaryrefslogtreecommitdiffstats
path: root/cpukit/score/inline/rtems
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2004-11-01 13:22:41 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2004-11-01 13:22:41 +0000
commitbaff4dafe1ff85d128a55e7b73780ca28f5c7faf (patch)
treee2acdf92de467f283ecd11fe621a67e79301e1cc /cpukit/score/inline/rtems
parent2004-11-01 Ralf Corsepius <ralf_corsepius@rtems.org> (diff)
downloadrtems-baff4dafe1ff85d128a55e7b73780ca28f5c7faf.tar.bz2
2004-11-01 Joel Sherrill <joel@oarcorp.com>
* score/cpu/no_cpu/rtems/score/cpu.h, score/include/rtems/debug.h, score/include/rtems/seterr.h, score/include/rtems/system.h, score/include/rtems/score/address.h, score/include/rtems/score/apiext.h, score/include/rtems/score/apimutex.h, score/include/rtems/score/bitfield.h, score/include/rtems/score/chain.h, score/include/rtems/score/context.h, score/include/rtems/score/copyrt.h, score/include/rtems/score/coremsg.h, score/include/rtems/score/coremutex.h, score/include/rtems/score/coresem.h, score/include/rtems/score/heap.h, score/include/rtems/score/interr.h, score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h, score/include/rtems/score/objectmp.h, score/include/rtems/score/priority.h, score/include/rtems/score/stack.h, score/include/rtems/score/states.h, score/include/rtems/score/sysstate.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadmp.h, score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h, score/include/rtems/score/userext.h, score/include/rtems/score/watchdog.h, score/include/rtems/score/wkspace.h, score/inline/rtems/score/address.inl, score/inline/rtems/score/chain.inl, score/inline/rtems/score/coremsg.inl, score/inline/rtems/score/coremutex.inl, score/inline/rtems/score/coresem.inl, score/inline/rtems/score/heap.inl, score/inline/rtems/score/isr.inl, score/inline/rtems/score/mppkt.inl, score/inline/rtems/score/objectmp.inl, score/inline/rtems/score/priority.inl, score/inline/rtems/score/stack.inl, score/inline/rtems/score/states.inl, score/inline/rtems/score/sysstate.inl, score/inline/rtems/score/thread.inl, score/inline/rtems/score/threadmp.inl, score/inline/rtems/score/tod.inl, score/inline/rtems/score/tqdata.inl, score/inline/rtems/score/userext.inl, score/inline/rtems/score/watchdog.inl, score/inline/rtems/score/wkspace.inl: Add Doxygen comments -- working modifications which are not complete and may have broken code. Committing so work and testing can proceed. * score/Doxyfile, score/mainpage.h: New files.
Diffstat (limited to '')
-rw-r--r--cpukit/score/inline/rtems/score/address.inl53
-rw-r--r--cpukit/score/inline/rtems/score/chain.inl174
-rw-r--r--cpukit/score/inline/rtems/score/coremsg.inl100
-rw-r--r--cpukit/score/inline/rtems/score/coremutex.inl61
-rw-r--r--cpukit/score/inline/rtems/score/coresem.inl57
-rw-r--r--cpukit/score/inline/rtems/score/heap.inl116
-rw-r--r--cpukit/score/inline/rtems/score/isr.inl31
-rw-r--r--cpukit/score/inline/rtems/score/mppkt.inl32
-rw-r--r--cpukit/score/inline/rtems/score/objectmp.inl37
-rw-r--r--cpukit/score/inline/rtems/score/priority.inl93
-rw-r--r--cpukit/score/inline/rtems/score/stack.inl39
-rw-r--r--cpukit/score/inline/rtems/score/states.inl164
-rw-r--r--cpukit/score/inline/rtems/score/sysstate.inl72
-rw-r--r--cpukit/score/inline/rtems/score/thread.inl172
-rw-r--r--cpukit/score/inline/rtems/score/threadmp.inl30
-rw-r--r--cpukit/score/inline/rtems/score/tod.inl37
-rw-r--r--cpukit/score/inline/rtems/score/tqdata.inl39
-rw-r--r--cpukit/score/inline/rtems/score/userext.inl53
-rw-r--r--cpukit/score/inline/rtems/score/watchdog.inl121
-rw-r--r--cpukit/score/inline/rtems/score/wkspace.inl30
20 files changed, 448 insertions, 1063 deletions
diff --git a/cpukit/score/inline/rtems/score/address.inl b/cpukit/score/inline/rtems/score/address.inl
index 28fa7f5c77..7f1f298ae4 100644
--- a/cpukit/score/inline/rtems/score/address.inl
+++ b/cpukit/score/inline/rtems/score/address.inl
@@ -1,9 +1,12 @@
-/* inline/address.inl
+/**
+ * @file address.inl
*
* This include file contains the bodies of the routines
* about addresses which are inlined.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __INLINE_ADDRESSES_inl
#define __INLINE_ADDRESSES_inl
-/*PAGE
- *
- * _Addresses_Add_offset
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreAddress
+ * @{
+ */
+
+/**
* This function is used to add an offset to a base address.
* It returns the resulting address. This address is typically
* converted to an access type before being used further.
@@ -35,12 +38,7 @@ RTEMS_INLINE_ROUTINE void *_Addresses_Add_offset (
return (void *)((char *)base + offset);
}
-/*PAGE
- *
- * _Addresses_Subtract_offset
- *
- * DESCRIPTION:
- *
+/**
* This function is used to subtract an offset from a base
* address. It returns the resulting address. This address is
* typically converted to an access type before being used further.
@@ -54,16 +52,11 @@ RTEMS_INLINE_ROUTINE void *_Addresses_Subtract_offset (
return (void *)((char *)base - offset);
}
-/*PAGE
- *
- * _Addresses_Subtract
- *
- * DESCRIPTION:
- *
+/**
* This function is used to subtract two addresses. It returns the
* resulting offset.
*
- * NOTE: The cast of an address to an uint32_t makes this code
+ * @note The cast of an address to an uint32_t makes this code
* dependent on an addresses being thirty two bits.
*/
@@ -75,12 +68,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Addresses_Subtract (
return ((char *) left - (char *) right);
}
-/*PAGE
- *
- * _Addresses_Is_aligned
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the given address is correctly
* aligned for this processor and FALSE otherwise. Proper alignment
* is based on correctness and efficiency.
@@ -99,12 +87,7 @@ RTEMS_INLINE_ROUTINE boolean _Addresses_Is_aligned (
#endif
}
-/*PAGE
- *
- * _Addresses_Is_in_range
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the given address is within the
* memory range specified and FALSE otherwise. base is the address
* of the first byte in the memory range and limit is the address
@@ -121,5 +104,7 @@ RTEMS_INLINE_ROUTINE boolean _Addresses_Is_in_range (
return ( address >= base && address <= limit );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/chain.inl b/cpukit/score/inline/rtems/score/chain.inl
index 8f9c68389d..a21841f413 100644
--- a/cpukit/score/inline/rtems/score/chain.inl
+++ b/cpukit/score/inline/rtems/score/chain.inl
@@ -1,13 +1,16 @@
-/* inline/chain.inl
+/**
+ * @file chain.inl
*
* This include file contains the bodies of the routines which are
* associated with doubly linked chains and inlined.
*
- * NOTE: The routines in this file are ordered from simple
+ * @note The routines in this file are ordered from simple
* to complex. No other Chain Handler routine is referenced
* unless it has already been defined.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -20,16 +23,15 @@
#ifndef __INLINE_CHAIN_inl
#define __INLINE_CHAIN_inl
-/*PAGE
- *
- * _Chain_Are_nodes_equal
- *
- * DESCRIPTION:
- *
- * This function returns TRUE if LEFT and RIGHT are equal,
- * and FALSE otherwise.
+/**
+ * @addtogroup ScoreChain
+ * @{
*/
+/**
+ * This function returns TRUE if \a left and \a right are equal,
+ * and FALSE otherwise.
+ */
RTEMS_INLINE_ROUTINE boolean _Chain_Are_nodes_equal(
Chain_Node *left,
Chain_Node *right
@@ -38,28 +40,16 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Are_nodes_equal(
return left == right;
}
-/*PAGE
- *
- * _Chain_Is_null
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_chain is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_null(
Chain_Control *the_chain
)
{
return ( the_chain == NULL );
}
-
-/*PAGE
- *
- * _Chain_Is_null_node
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_node is NULL and FALSE otherwise.
*/
@@ -70,15 +60,9 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_null_node(
return ( the_node == NULL );
}
-/*PAGE
- *
- * _Chain_Head
- *
- * DESCRIPTION:
- *
+/**
* This function returns a pointer to the first node on the chain.
*/
-
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
Chain_Control *the_chain
)
@@ -86,15 +70,9 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
return (Chain_Node *) the_chain;
}
-/*PAGE
- *
- * _Chain_Tail
- *
- * DESCRIPTION:
- *
+/**
* This function returns a pointer to the last node on the chain.
*/
-
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
Chain_Control *the_chain
)
@@ -102,16 +80,10 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
return (Chain_Node *) &the_chain->permanent_null;
}
-/*PAGE
- *
- * _Chain_Is_empty
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if there a no nodes on the_chain and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_empty(
Chain_Control *the_chain
)
@@ -119,16 +91,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_empty(
return ( the_chain->first == _Chain_Tail( the_chain ) );
}
-/*PAGE
- *
- * _Chain_Is_first
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_node is the first node on a chain and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_first(
Chain_Node *the_node
)
@@ -136,16 +102,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_first(
return ( the_node->previous == NULL );
}
-/*PAGE
- *
- * _Chain_Is_last
- *
- * DESCRIPTION:
- *
- * This function returns TRUE if the_node is the last node on a chain and
+/**
+ * This function returns TRUE if \a the_node is the last node on a chain and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_last(
Chain_Node *the_node
)
@@ -153,13 +113,8 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_last(
return ( the_node->next == NULL );
}
-/*PAGE
- *
- * _Chain_Has_only_one_node
- *
- * DESCRIPTION:
- *
- * This function returns TRUE if there is only one node on the_chain and
+/**
+ * This function returns TRUE if there is only one node on \a the_chain and
* FALSE otherwise.
*/
@@ -170,16 +125,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Has_only_one_node(
return ( the_chain->first == the_chain->last );
}
-/*PAGE
- *
- * _Chain_Is_head
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_node is the head of the_chain and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_head(
Chain_Control *the_chain,
Chain_Node *the_node
@@ -188,16 +137,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_head(
return ( the_node == _Chain_Head( the_chain ) );
}
-/*PAGE
- *
- * _Chain_Is_tail
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_node is the tail of the_chain and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Chain_Is_tail(
Chain_Control *the_chain,
Chain_Node *the_node
@@ -206,12 +149,7 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_tail(
return ( the_node == _Chain_Tail( the_chain ) );
}
-/*PAGE
- *
- * Chain_Initialize_empty
- *
- * DESCRIPTION:
- *
+/**
* This routine initializes the specified chain to contain zero nodes.
*/
@@ -224,17 +162,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Initialize_empty(
the_chain->last = _Chain_Head( the_chain );
}
-/*PAGE
- *
- * _Chain_Extract_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This routine extracts the_node from the chain on which it resides.
* It does NOT disable interrupts to insure the atomicity of the
* extract operation.
*/
-
RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
Chain_Node *the_node
)
@@ -248,17 +180,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
previous->next = next;
}
-/*PAGE
- *
- * _Chain_Get_first_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This function removes the first node from the_chain and returns
* a pointer to that node. It does NOT disable interrupts to insure
* the atomicity of the get operation.
*/
-
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
Chain_Control *the_chain
)
@@ -274,18 +200,12 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
return return_node;
}
-/*PAGE
- *
- * Chain_Get_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This function removes the first node from the_chain and returns
* a pointer to that node. If the_chain is empty, then NULL is returned.
* It does NOT disable interrupts to insure the atomicity of the
* get operation.
*/
-
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
Chain_Control *the_chain
)
@@ -296,12 +216,7 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
return NULL;
}
-/*PAGE
- *
- * _Chain_Insert_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This routine inserts the_node on a chain immediately following
* after_node. It does NOT disable interrupts to insure the atomicity
* of the extract operation.
@@ -321,17 +236,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Insert_unprotected(
before_node->previous = the_node;
}
-/*PAGE
- *
- * _Chain_Append_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This routine appends the_node onto the end of the_chain.
* It does NOT disable interrupts to insure the atomicity of the
* append operation.
*/
-
RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
Chain_Control *the_chain,
Chain_Node *the_node
@@ -346,37 +255,24 @@ RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
the_node->previous = old_last_node;
}
-/*PAGE
- *
- * _Chain_Prepend_unprotected
- *
- * DESCRIPTION:
- *
+/**
* This routine prepends the_node onto the front of the_chain.
* It does NOT disable interrupts to insure the atomicity of the
* prepend operation.
*/
-
RTEMS_INLINE_ROUTINE void _Chain_Prepend_unprotected(
Chain_Control *the_chain,
Chain_Node *the_node
)
{
_Chain_Insert_unprotected( _Chain_Head( the_chain ), the_node );
-
}
-/*PAGE
- *
- * _Chain_Prepend
- *
- * DESCRIPTION:
- *
+/**
* This routine prepends the_node onto the front of the_chain.
* It disables interrupts to insure the atomicity of the
* prepend operation.
*/
-
RTEMS_INLINE_ROUTINE void _Chain_Prepend(
Chain_Control *the_chain,
Chain_Node *the_node
@@ -385,5 +281,7 @@ RTEMS_INLINE_ROUTINE void _Chain_Prepend(
_Chain_Insert( _Chain_Head( the_chain ), the_node );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/coremsg.inl b/cpukit/score/inline/rtems/score/coremsg.inl
index 7d152aec6b..56dea73b6d 100644
--- a/cpukit/score/inline/rtems/score/coremsg.inl
+++ b/cpukit/score/inline/rtems/score/coremsg.inl
@@ -1,9 +1,12 @@
-/* coremsg.inl
+/**
+ * @file coremsg.inl
*
* This include file contains the static inline implementation of all
* inlined routines in the Core Message Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,14 +19,14 @@
#ifndef __CORE_MESSAGE_QUEUE_inl
#define __CORE_MESSAGE_QUEUE_inl
+/**
+ * @addtogroup ScoreMessageQueue
+ * @{
+ */
+
#include <string.h> /* needed for memcpy */
-/*PAGE
- *
- * _CORE_message_queue_Send
- *
- * DESCRIPTION:
- *
+/**
* This routine sends a message to the end of the specified message queue.
*/
@@ -53,12 +56,7 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Send(
);
}
-/*PAGE
- *
- * _CORE_message_queue_Urgent
- *
- * DESCRIPTION:
- *
+/**
* This routine sends a message to the front of the specified message queue.
*/
@@ -88,12 +86,7 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Urgent(
);
}
-/*PAGE
- *
- * _CORE_message_queue_Copy_buffer
- *
- * DESCRIPTION:
- *
+/**
* This routine copies the contents of the source message buffer
* to the destination message buffer.
*/
@@ -107,12 +100,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Copy_buffer (
memcpy(destination, source, size);
}
-/*PAGE
- *
- * _CORE_message_queue_Allocate_message_buffer
- *
- * DESCRIPTION:
- *
+/**
* This function allocates a message buffer from the inactive
* message buffer chain.
*/
@@ -126,12 +114,7 @@ _CORE_message_queue_Allocate_message_buffer (
_Chain_Get( &the_message_queue->Inactive_messages );
}
-/*PAGE
- *
- * _CORE_message_queue_Free_message_buffer
- *
- * DESCRIPTION:
- *
+/**
* This routine frees a message buffer to the inactive
* message buffer chain.
*/
@@ -144,12 +127,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Free_message_buffer (
_Chain_Append( &the_message_queue->Inactive_messages, &the_message->Node );
}
-/*PAGE
- *
- * _CORE_message_queue_Get_pending_message
- *
- * DESCRIPTION:
- *
+/**
* This function removes the first message from the_message_queue
* and returns a pointer to it.
*/
@@ -163,12 +141,7 @@ RTEMS_INLINE_ROUTINE
_Chain_Get_unprotected( &the_message_queue->Pending_messages );
}
-/*PAGE
- *
- * _CORE_message_queue_Is_priority
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the priority attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
@@ -180,12 +153,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_priority(
return (the_attribute->discipline == CORE_MESSAGE_QUEUE_DISCIPLINES_PRIORITY);
}
-/*PAGE
- *
- * _CORE_message_queue_Append
- *
- * DESCRIPTION:
- *
+/**
* This routine places the_message at the rear of the outstanding
* messages on the_message_queue.
*/
@@ -198,12 +166,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Append (
_Chain_Append( &the_message_queue->Pending_messages, &the_message->Node );
}
-/*PAGE
- *
- * _CORE_message_queue_Prepend
- *
- * DESCRIPTION:
- *
+/**
* This routine places the_message at the front of the outstanding
* messages on the_message_queue.
*/
@@ -219,12 +182,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Prepend (
);
}
-/*PAGE
- *
- * _CORE_message_queue_Is_null
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_message_queue is TRUE and FALSE otherwise.
*/
@@ -235,12 +193,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_null (
return ( the_message_queue == NULL );
}
-/*PAGE
- *
- * _CORE_message_queue_Is_notify_enabled
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if notification is enabled on this message
* queue and FALSE otherwise.
*/
@@ -252,12 +205,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_notify_enabled (
return (the_message_queue->notify_handler != NULL);
}
-/*PAGE
- *
- * _CORE_message_queue_Set_notify
- *
- * DESCRIPTION:
- *
+/**
* This routine initializes the notification information for the_message_queue.
*/
@@ -271,5 +219,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_notify (
the_message_queue->notify_argument = the_argument;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/coremutex.inl b/cpukit/score/inline/rtems/score/coremutex.inl
index 2d884b79f9..3040142636 100644
--- a/cpukit/score/inline/rtems/score/coremutex.inl
+++ b/cpukit/score/inline/rtems/score/coremutex.inl
@@ -1,9 +1,12 @@
-/* inline/coremutex.inl
+/**
+ * @file coremutex.inl
*
* This include file contains all of the inlined routines associated
* with the CORE mutexes.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __INLINE_CORE_MUTEX_inl
#define __INLINE_CORE_MUTEX_inl
-/*PAGE
- *
- * _CORE_mutex_Is_locked
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreMutex
+ * @{
+ */
+
+/**
* This routine returns TRUE if the mutex specified is locked and FALSE
* otherwise.
*/
@@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_locked(
return the_mutex->lock == CORE_MUTEX_LOCKED;
}
-/*PAGE
- *
- * _CORE_mutex_Is_fifo
- *
- * DESCRIPTION:
- *
+/**
* This routine returns TRUE if the mutex's wait discipline is FIFO and FALSE
* otherwise.
*/
@@ -50,12 +48,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_fifo(
return the_attribute->discipline == CORE_MUTEX_DISCIPLINES_FIFO;
}
-/*PAGE
- *
- * _CORE_mutex_Is_priority
- *
- * DESCRIPTION:
- *
+/**
* This routine returns TRUE if the mutex's wait discipline is PRIORITY and
* FALSE otherwise.
*/
@@ -67,12 +60,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority(
return the_attribute->discipline == CORE_MUTEX_DISCIPLINES_PRIORITY;
}
-/*PAGE
- *
- * _CORE_mutex_Is_inherit_priority
- *
- * DESCRIPTION:
- *
+/**
* This routine returns TRUE if the mutex's wait discipline is
* INHERIT_PRIORITY and FALSE otherwise.
*/
@@ -84,12 +72,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_inherit_priority(
return the_attribute->discipline == CORE_MUTEX_DISCIPLINES_PRIORITY_INHERIT;
}
-/*PAGE
- *
- * _CORE_mutex_Is_priority_ceiling
- *
- * DESCRIPTION:
- *
+/**
* This routine returns TRUE if the mutex's wait discipline is
* PRIORITY_CEILING and FALSE otherwise.
*/
@@ -101,12 +84,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority_ceiling(
return the_attribute->discipline == CORE_MUTEX_DISCIPLINES_PRIORITY_CEILING;
}
-/*PAGE
- *
- * _CORE_mutex_Seize_interrupt_trylock
- *
- * DESCRIPTION:
- *
+/*
* This routine returns 0 if "trylock" can resolve whether or not the
* mutex is immediately obtained or there was an error attempting to
* get it. It returns 1 to indicate that the caller cannot obtain
@@ -115,8 +93,9 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority_ceiling(
* NOTE: There is no MACRO version of this routine.
* A body is in coremutexseize.c that is duplicated
* from the .inl by hand.
+ *
+ * NOTE: The Doxygen for this routine is in the .h file.
*/
-
RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock(
CORE_mutex_Control *the_mutex,
ISR_Level *level_p
@@ -192,5 +171,7 @@ RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock(
return 1;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/coresem.inl b/cpukit/score/inline/rtems/score/coresem.inl
index 4c39764e23..b2a6282b39 100644
--- a/cpukit/score/inline/rtems/score/coresem.inl
+++ b/cpukit/score/inline/rtems/score/coresem.inl
@@ -1,9 +1,12 @@
-/* inline/coresem.inl
+/**
+ * @file coresem.inl
*
* This include file contains all of the inlined routines associated
* with the CORE semaphore.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,19 +19,21 @@
#ifndef __INLINE_CORE_SEMAPHORE_inl
#define __INLINE_CORE_SEMAPHORE_inl
+/**
+ * @addtogroup ScoreSemaphore
+ * @{
+ */
+
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
-/*PAGE
- *
- * _CORE_semaphore_Is_priority
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the priority attribute is
* enabled in the attribute_set and FALSE otherwise.
+ *
+ * @param the_attribute (in) is the attribute set to test
+ * @return TRUE if the priority attribute is enabled
*/
-
RTEMS_INLINE_ROUTINE boolean _CORE_semaphore_Is_priority(
CORE_semaphore_Attributes *the_attribute
)
@@ -36,36 +41,34 @@ RTEMS_INLINE_ROUTINE boolean _CORE_semaphore_Is_priority(
return ( the_attribute->discipline == CORE_SEMAPHORE_DISCIPLINES_PRIORITY );
}
-/*PAGE
- *
- * _CORE_semaphore_Get_count
- *
- * DESCRIPTION:
- *
+/**
* This routine returns the current count associated with the semaphore.
+ *
+ * @param the_semaphore (in) is the semaphore to obtain the count of
+ * @return the current count of this semaphore
*/
-
-RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count(
+RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count(
CORE_semaphore_Control *the_semaphore
)
{
return the_semaphore->count;
}
-/*PAGE
- *
- * _CORE_semaphore_Seize_isr_disable
- *
- * DESCRIPTION:
- *
+/**
* This routine attempts to receive a unit from the_semaphore.
* If a unit is available or if the wait flag is FALSE, then the routine
* returns. Otherwise, the calling task is blocked until a unit becomes
* available.
*
- * NOTE: There is currently no MACRO version of this routine.
+ * @param the_semaphore (in) is the semaphore to obtain
+ * @param id (in) is the Id of the owning API level Semaphore object
+ * @param wait (in) is TRUE if the thread is willing to wait
+ * @param timeout (in) is the maximum number of ticks to block
+ * @param level_p (in) is a temporary variable used to contain the ISR
+ * disable level cookie
+ *
+ * @note There is currently no MACRO version of this routine.
*/
-
RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
CORE_semaphore_Control *the_semaphore,
Objects_Id id,
@@ -103,5 +106,7 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
_Thread_Enable_dispatch();
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/heap.inl b/cpukit/score/inline/rtems/score/heap.inl
index ae41cf6244..f8d2cca0c3 100644
--- a/cpukit/score/inline/rtems/score/heap.inl
+++ b/cpukit/score/inline/rtems/score/heap.inl
@@ -1,9 +1,12 @@
-/* heap.inl
+/**
+ * @file heap.inl
*
* This file contains the static inline implementation of the inlined
* routines from the heap handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,14 +19,14 @@
#ifndef __HEAP_inl
#define __HEAP_inl
+/**
+ * @addtogroup ScoreHeap
+ * @{
+ */
+
#include <rtems/score/address.h>
-/*PAGE
- *
- * _Heap_Head
- *
- * DESCRIPTION:
- *
+/**
* This function returns the head of the specified heap.
*/
@@ -34,12 +37,7 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Head (
return (Heap_Block *)&the_heap->start;
}
-/*PAGE
- *
- * _Heap_Tail
- *
- * DESCRIPTION:
- *
+/**
* This function returns the tail of the specified heap.
*/
@@ -50,12 +48,7 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Tail (
return (Heap_Block *)&the_heap->final;
}
-/*PAGE
- *
- * _Heap_Previous_block
- *
- * DESCRIPTION:
- *
+/**
* This function returns the address of the block which physically
* precedes the_block in memory.
*/
@@ -70,16 +63,11 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Previous_block (
);
}
-/*PAGE
- *
- * _Heap_Next_block
- *
- * DESCRIPTION:
- *
+/**
* This function returns the address of the block which physically
* follows the_block in memory.
*
- * NOTE: Next_block assumes that the block is free.
+ * @note Next_block assumes that the block is free.
*/
RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Next_block (
@@ -92,12 +80,7 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Next_block (
);
}
-/*PAGE
- *
- * _Heap_Block_at
- *
- * DESCRIPTION:
- *
+/**
* This function calculates and returns a block's location (address)
* in the heap based upon a base address and an offset.
*/
@@ -110,12 +93,7 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_Block_at(
return (Heap_Block *) _Addresses_Add_offset( (void *)base, offset );
}
-/*PAGE
- *
- * _Heap_User_block_at
- *
- * DESCRIPTION:
- *
+/**
* XXX
*/
@@ -129,12 +107,7 @@ RTEMS_INLINE_ROUTINE Heap_Block *_Heap_User_block_at(
return _Heap_Block_at( base, -offset + -HEAP_BLOCK_USED_OVERHEAD);
}
-/*PAGE
- *
- * _Heap_Is_previous_block_free
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the previous block of the_block
* is free, and FALSE otherwise.
*/
@@ -146,12 +119,7 @@ RTEMS_INLINE_ROUTINE boolean _Heap_Is_previous_block_free (
return !(the_block->back_flag & HEAP_BLOCK_USED);
}
-/*PAGE
- *
- * _Heap_Is_block_free
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the block is free, and FALSE otherwise.
*/
@@ -162,12 +130,7 @@ RTEMS_INLINE_ROUTINE boolean _Heap_Is_block_free (
return !(the_block->front_flag & HEAP_BLOCK_USED);
}
-/*PAGE
- *
- * _Heap_Is_block_used
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the block is currently allocated,
* and FALSE otherwise.
*/
@@ -179,12 +142,7 @@ RTEMS_INLINE_ROUTINE boolean _Heap_Is_block_used (
return (the_block->front_flag & HEAP_BLOCK_USED);
}
-/*PAGE
- *
- * _Heap_Block_size
- *
- * DESCRIPTION:
- *
+/**
* This function returns the size of the_block in bytes.
*/
@@ -195,12 +153,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Heap_Block_size (
return (the_block->front_flag & ~HEAP_BLOCK_USED);
}
-/*PAGE
- *
- * _Heap_Start_of_user_area
- *
- * DESCRIPTION:
- *
+/**
* This function returns the starting address of the portion of the block
* which the user may access.
*/
@@ -212,12 +165,7 @@ RTEMS_INLINE_ROUTINE void *_Heap_Start_of_user_area (
return (void *) &the_block->next;
}
-/*PAGE
- *
- * _Heap_Is_block_in
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_block is within the memory area
* managed by the_heap, and FALSE otherwise.
*/
@@ -230,12 +178,7 @@ RTEMS_INLINE_ROUTINE boolean _Heap_Is_block_in (
return _Addresses_Is_in_range( the_block, the_heap->start, the_heap->final );
}
-/*PAGE
- *
- * _Heap_Is_page_size_valid
- *
- * DESCRIPTION:
- *
+/**
* This function validates a specified heap page size. If the page size
* is 0 or if lies outside a page size alignment boundary it is invalid
* and FALSE is returned. Otherwise, the page size is valid and TRUE is
@@ -250,12 +193,7 @@ RTEMS_INLINE_ROUTINE boolean _Heap_Is_page_size_valid(
((page_size % CPU_HEAP_ALIGNMENT) == 0));
}
-/*PAGE
- *
- * _Heap_Build_flag
- *
- * DESCRIPTION:
- *
+/**
* This function returns the block flag composed of size and in_use_flag.
* The flag returned is suitable for use as a back or front flag in a
* heap block.
@@ -269,5 +207,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Heap_Build_flag (
return size | in_use_flag;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/isr.inl b/cpukit/score/inline/rtems/score/isr.inl
index 637098b297..dedbd150cd 100644
--- a/cpukit/score/inline/rtems/score/isr.inl
+++ b/cpukit/score/inline/rtems/score/isr.inl
@@ -1,9 +1,12 @@
-/* isr.inl
+/**
+ * @file isr.inl
*
* This include file contains the static implementation of all
* inlined routines in the Interrupt Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __ISR_inl
#define __ISR_inl
-/*PAGE
- *
- * _ISR_Is_vector_number_valid
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreISR
+ * @{
+ */
+
+/**
* This function returns TRUE if the vector is a valid vector number
* for this processor and FALSE otherwise.
*/
@@ -33,13 +36,7 @@ RTEMS_INLINE_ROUTINE boolean _ISR_Is_vector_number_valid (
return ( vector <= CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER );
}
-/*PAGE
- *
- * _ISR_Is_valid_user_handler
- *
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if handler is the entry point of a valid
* use interrupt service routine and FALSE otherwise.
*/
@@ -51,5 +48,7 @@ RTEMS_INLINE_ROUTINE boolean _ISR_Is_valid_user_handler (
return ( handler != NULL);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/mppkt.inl b/cpukit/score/inline/rtems/score/mppkt.inl
index a26713776d..77f5664eb0 100644
--- a/cpukit/score/inline/rtems/score/mppkt.inl
+++ b/cpukit/score/inline/rtems/score/mppkt.inl
@@ -1,9 +1,12 @@
-/* inline/mppkt.inl
+/**
+ * @file mppkt.inl
*
* This package is the implementation of the Packet Handler
* routines which are inlined.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,16 +19,16 @@
#ifndef __INLINE_MP_PACKET_inl
#define __INLINE_MP_PACKET_inl
-/*PAGE
- *
- * _Mp_packet_Is_valid_packet_class
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreMPPacket
+ * @{
+ */
+
+/**
* This function returns TRUE if the the_packet_class is valid,
* and FALSE otherwise.
*
- * NOTE: Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
+ * @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
* because this enum starts at lower bound of zero.
*/
@@ -36,12 +39,7 @@ RTEMS_INLINE_ROUTINE boolean _Mp_packet_Is_valid_packet_class (
return ( the_packet_class <= MP_PACKET_CLASSES_LAST );
}
-/*PAGE
- *
- * _Mp_packet_Is_null
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the the_packet_class is null,
* and FALSE otherwise.
*/
@@ -53,5 +51,7 @@ RTEMS_INLINE_ROUTINE boolean _Mp_packet_Is_null (
return the_packet == NULL;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/objectmp.inl b/cpukit/score/inline/rtems/score/objectmp.inl
index 462a670876..ddd48fdf1b 100644
--- a/cpukit/score/inline/rtems/score/objectmp.inl
+++ b/cpukit/score/inline/rtems/score/objectmp.inl
@@ -1,9 +1,12 @@
-/* inline/objectmp.inl
+/**
+ * @file objectmp.inl
*
* This include file contains the bodies of all inlined routines
* which deal with global objects.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __INLINE_MP_OBJECTS_inl
#define __INLINE_MP_OBJECTS_inl
-/*PAGE
- *
- * _Objects_MP_Allocate_global_object
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreObjectMP
+ * @{
+ */
+
+/**
* This function allocates a Global Object control block.
*/
@@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE Objects_MP_Control *_Objects_MP_Allocate_global_object (
_Chain_Get( &_Objects_MP_Inactive_global_objects );
}
-/*PAGE
- *
- * _Objects_MP_Free_global_object
- *
- * DESCRIPTION:
- *
+/**
* This routine deallocates a Global Object control block.
*/
@@ -52,12 +50,7 @@ RTEMS_INLINE_ROUTINE void _Objects_MP_Free_global_object (
);
}
-/*PAGE
- *
- * _Objects_MP_Is_null_global_object
- *
- * DESCRIPTION:
- *
+/**
* This function returns whether the global object is NULL or not.
*/
@@ -68,5 +61,7 @@ RTEMS_INLINE_ROUTINE boolean _Objects_MP_Is_null_global_object (
return( the_object == NULL );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/priority.inl b/cpukit/score/inline/rtems/score/priority.inl
index ef7e366213..509b52e5f2 100644
--- a/cpukit/score/inline/rtems/score/priority.inl
+++ b/cpukit/score/inline/rtems/score/priority.inl
@@ -1,9 +1,12 @@
-/* priority.inl
+/**
+ * @file priority.inl
*
* This file contains the static inline implementation of all inlined
* routines in the Priority Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,14 +19,14 @@
#ifndef __PRIORITY_inl
#define __PRIORITY_inl
+/**
+ * @addtogroup ScorePriority
+ * @{
+ */
+
#include <rtems/score/bitfield.h>
-/*PAGE
- *
- * _Priority_Handler_initialization
- *
- * DESCRIPTION:
- *
+/**
* This routine performs the initialization necessary for this handler.
*/
@@ -36,12 +39,7 @@ RTEMS_INLINE_ROUTINE void _Priority_Handler_initialization( void )
_Priority_Bit_map[ index ] = 0;
}
-/*PAGE
- *
- * _Priority_Is_valid
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_priority if valid for a
* user task, and FALSE otherwise.
*/
@@ -58,12 +56,7 @@ RTEMS_INLINE_ROUTINE boolean _Priority_Is_valid (
return ( the_priority <= PRIORITY_MAXIMUM );
}
-/*PAGE
- *
- * _Priority_Major
- *
- * DESCRIPTION:
- *
+/**
* This function returns the major portion of the_priority.
*/
@@ -74,12 +67,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Priority_Major (
return ( the_priority / 16 );
}
-/*PAGE
- *
- * _Priority_Minor
- *
- * DESCRIPTION:
- *
+/**
* This function returns the minor portion of the_priority.
*/
@@ -92,12 +80,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Priority_Minor (
#if ( CPU_USE_GENERIC_BITFIELD_CODE == TRUE )
-/*PAGE
- *
- * _Priority_Mask
- *
- * DESCRIPTION:
- *
+/**
* This function returns the mask associated with the major or minor
* number passed to it.
*/
@@ -110,12 +93,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Priority_Mask (
}
-/*PAGE
- *
- * _Priority_Bits_index
- *
- * DESCRIPTION:
- *
+/**
* This function translates the bit numbers returned by the bit scan
* of a priority bit field into something suitable for use as
* a major or minor component of a priority.
@@ -130,12 +108,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Priority_Bits_index (
#endif
-/*PAGE
- *
- * _Priority_Add_to_bit_map
- *
- * DESCRIPTION:
- *
+/**
* This routine uses the_priority_map to update the priority
* bit maps to indicate that a thread has been readied.
*/
@@ -148,12 +121,7 @@ RTEMS_INLINE_ROUTINE void _Priority_Add_to_bit_map (
_Priority_Major_bit_map |= the_priority_map->ready_major;
}
-/*PAGE
- *
- * _Priority_Remove_from_bit_map
- *
- * DESCRIPTION:
- *
+/**
* This routine uses the_priority_map to update the priority
* bit maps to indicate that a thread has been removed from the
* ready state.
@@ -168,12 +136,7 @@ RTEMS_INLINE_ROUTINE void _Priority_Remove_from_bit_map (
_Priority_Major_bit_map &= the_priority_map->block_major;
}
-/*PAGE
- *
- * _Priority_Get_highest
- *
- * DESCRIPTION:
- *
+/**
* This function returns the priority of the highest priority
* ready thread.
*/
@@ -190,12 +153,7 @@ RTEMS_INLINE_ROUTINE Priority_Control _Priority_Get_highest( void )
_Priority_Bits_index( minor );
}
-/*PAGE
- *
- * _Priority_Initialize_information
- *
- * DESCRIPTION:
- *
+/**
* This routine initializes the_priority_map so that it
* contains the information necessary to manage a thread
* at new_priority.
@@ -225,12 +183,7 @@ RTEMS_INLINE_ROUTINE void _Priority_Initialize_information(
the_priority_map->block_minor = ~mask;
}
-/*PAGE
- *
- * _Priority_Is_group_empty
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the priority GROUP is empty, and
* FALSE otherwise.
*/
@@ -242,5 +195,7 @@ RTEMS_INLINE_ROUTINE boolean _Priority_Is_group_empty (
return the_priority == 0;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/stack.inl b/cpukit/score/inline/rtems/score/stack.inl
index 5bfd3c1622..e02da4fbe0 100644
--- a/cpukit/score/inline/rtems/score/stack.inl
+++ b/cpukit/score/inline/rtems/score/stack.inl
@@ -1,9 +1,12 @@
-/* stack.inl
+/**
+ * @file stack.inl
*
* This file contains the static inline implementation of the inlined
* routines from the Stack Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __STACK_inl
#define __STACK_inl
-/*PAGE
- *
- * _Stack_Initialize
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreStack
+ * @{
+ */
+
+/**
* This routine initializes the_stack record to indicate that
* size bytes of memory starting at starting_address have been
* reserved for a stack.
@@ -37,12 +40,7 @@ RTEMS_INLINE_ROUTINE void _Stack_Initialize (
the_stack->size = size;
}
-/*PAGE
- *
- * _Stack_Is_enough
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if size bytes is enough memory for
* a valid stack area on this processor, and FALSE otherwise.
*/
@@ -54,17 +52,12 @@ RTEMS_INLINE_ROUTINE boolean _Stack_Is_enough (
return ( size >= STACK_MINIMUM_SIZE );
}
-/*PAGE
- *
- * _Stack_Adjust_size
- *
- * DESCRIPTION:
- *
+/**
* This function increases the stack size to insure that the thread
* has the desired amount of stack space after the initial stack
* pointer is determined based on alignment restrictions.
*
- * NOTE:
+ * @note
*
* The amount of adjustment for alignment is CPU dependent.
*/
@@ -76,5 +69,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Stack_Adjust_size (
return size + CPU_STACK_ALIGNMENT;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/states.inl b/cpukit/score/inline/rtems/score/states.inl
index 0122f74e7d..2701692f19 100644
--- a/cpukit/score/inline/rtems/score/states.inl
+++ b/cpukit/score/inline/rtems/score/states.inl
@@ -1,9 +1,12 @@
-/* states.inl
+/**
+ * @file states.inl
*
* This file contains the macro implementation of the inlined
* routines associated with thread state information.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __STATES_inl
#define __STATES_inl
-/*PAGE
- *
- * _States_Set
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreStates
+ * @{
+ */
+
+/**
* This function sets the given states_to_set into the current_state
* passed in. The result is returned to the user in current_state.
*/
@@ -34,12 +37,7 @@ RTEMS_INLINE_ROUTINE States_Control _States_Set (
return (current_state | states_to_set);
}
-/*PAGE
- *
- * _States_Clear
- *
- * DESCRIPTION:
- *
+/**
* This function clears the given states_to_clear into the current_state
* passed in. The result is returned to the user in current_state.
*/
@@ -52,12 +50,7 @@ RTEMS_INLINE_ROUTINE States_Control _States_Clear (
return (current_state & ~states_to_clear);
}
-/*PAGE
- *
- * _States_Is_ready
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_states indicates that the
* state is READY, and FALSE otherwise.
*/
@@ -69,12 +62,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_ready (
return (the_states == STATES_READY);
}
-/*PAGE
- *
- * _States_Is_only_dormant
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the DORMANT state is the ONLY state
* set in the_states, and FALSE otherwise.
*/
@@ -86,12 +74,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_only_dormant (
return (the_states == STATES_DORMANT);
}
-/*PAGE
- *
- * _States_Is_dormant
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the DORMANT state is set in
* the_states, and FALSE otherwise.
*/
@@ -103,12 +86,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_dormant (
return (the_states & STATES_DORMANT);
}
-/*PAGE
- *
- * _States_Is_suspended
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the SUSPENDED state is set in
* the_states, and FALSE otherwise.
*/
@@ -120,12 +98,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_suspended (
return (the_states & STATES_SUSPENDED);
}
-/*PAGE
- *
- * _States_Is_Transient
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the TRANSIENT state is set in
* the_states, and FALSE otherwise.
*/
@@ -137,12 +110,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_transient (
return (the_states & STATES_TRANSIENT);
}
-/*PAGE
- *
- * _States_Is_delaying
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the DELAYING state is set in
* the_states, and FALSE otherwise.
*/
@@ -154,12 +122,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_delaying (
return (the_states & STATES_DELAYING);
}
-/*PAGE
- *
- * _States_Is_waiting_for_buffer
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_BUFFER state is set in
* the_states, and FALSE otherwise.
*/
@@ -171,12 +134,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_buffer (
return (the_states & STATES_WAITING_FOR_BUFFER);
}
-/*PAGE
- *
- * _States_Is_waiting_for_segment
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_SEGMENT state is set in
* the_states, and FALSE otherwise.
*/
@@ -188,12 +146,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_segment (
return (the_states & STATES_WAITING_FOR_SEGMENT);
}
-/*PAGE
- *
- * _States_Is_waiting_for_message
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_MESSAGE state is set in
* the_states, and FALSE otherwise.
*/
@@ -205,12 +158,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_message (
return (the_states & STATES_WAITING_FOR_MESSAGE);
}
-/*PAGE
- *
- * _States_Is_waiting_for_event
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_EVENT state is set in
* the_states, and FALSE otherwise.
*/
@@ -222,12 +170,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_event (
return (the_states & STATES_WAITING_FOR_EVENT);
}
-/*PAGE
- *
- * _States_Is_waiting_for_mutex
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_MUTEX state
* is set in the_states, and FALSE otherwise.
*/
@@ -239,12 +182,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_mutex (
return (the_states & STATES_WAITING_FOR_MUTEX);
}
-/*PAGE
- *
- * _States_Is_waiting_for_semaphore
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_SEMAPHORE state
* is set in the_states, and FALSE otherwise.
*/
@@ -256,12 +194,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_semaphore (
return (the_states & STATES_WAITING_FOR_SEMAPHORE);
}
-/*PAGE
- *
- * _States_Is_waiting_for_time
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_TIME state is set in
* the_states, and FALSE otherwise.
*/
@@ -273,12 +206,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_time (
return (the_states & STATES_WAITING_FOR_TIME);
}
-/*PAGE
- *
- * _States_Is_waiting_for_rpc_reply
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_TIME state is set in
* the_states, and FALSE otherwise.
*/
@@ -290,12 +218,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_rpc_reply (
return (the_states & STATES_WAITING_FOR_RPC_REPLY);
}
-/*PAGE
- *
- * _States_Is_waiting_for_period
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the WAITING_FOR_PERIOD state is set in
* the_states, and FALSE otherwise.
*/
@@ -307,12 +230,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_period (
return (the_states & STATES_WAITING_FOR_PERIOD);
}
-/*PAGE
- *
- * _States_Is_locally_blocked
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if one of the states which indicates
* that a task is blocked waiting for a local resource is set in
* the_states, and FALSE otherwise.
@@ -325,12 +243,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_locally_blocked (
return (the_states & STATES_LOCALLY_BLOCKED);
}
-/*PAGE
- *
- * _States_Is_waiting_on_thread_queue
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if one of the states which indicates
* that a task is blocked waiting for a local resource is set in
* the_states, and FALSE otherwise.
@@ -343,12 +256,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_on_thread_queue (
return (the_states & STATES_WAITING_ON_THREAD_QUEUE);
}
-/*PAGE
- *
- * _States_Is_blocked
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if one of the states which indicates
* that a task is blocked is set in the_states, and FALSE otherwise.
*/
@@ -360,13 +268,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_blocked (
return (the_states & STATES_BLOCKED);
}
-/*PAGE
- *
- *
- * _States_Are_set
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if any of the states in the mask
* are set in the_states, and FALSE otherwise.
*/
@@ -379,5 +281,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Are_set (
return ( (the_states & mask) != STATES_READY);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/sysstate.inl b/cpukit/score/inline/rtems/score/sysstate.inl
index 4aa3295efe..63cfe8cde4 100644
--- a/cpukit/score/inline/rtems/score/sysstate.inl
+++ b/cpukit/score/inline/rtems/score/sysstate.inl
@@ -1,9 +1,12 @@
-/* sysstates.inl
+/**
+ * @file sysstate.inl
*
* This file contains the inline implementation of routines regarding the
* system state.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __SYSTEM_STATE_inl
#define __SYSTEM_STATE_inl
-/*PAGE
- *
- * _System_state_Handler_initialization
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreSysState
+ * @{
+ */
+
+/**
* This routine initializes the system state handler.
*/
@@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE void _System_state_Handler_initialization (
_System_state_Is_multiprocessing = is_multiprocessing;
}
-/*PAGE
- *
- * _System_state_Set
- *
- * DESCRIPTION:
- *
+/**
* This routine sets the current system state to that specified by
* the called.
*/
@@ -50,12 +48,7 @@ RTEMS_INLINE_ROUTINE void _System_state_Set (
_System_state_Current = state;
}
-/*PAGE
- *
- * _System_state_Get
- *
- * DESCRIPTION:
- *
+/**
* This function returns the current system state.
*/
@@ -64,12 +57,7 @@ RTEMS_INLINE_ROUTINE System_state_Codes _System_state_Get ( void )
return _System_state_Current;
}
-/*PAGE
- *
- * _System_state_Is_before_initialization
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the state is equal to the
* "before initialization" state, and FALSE otherwise.
*/
@@ -81,12 +69,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_before_initialization (
return (state == SYSTEM_STATE_BEFORE_INITIALIZATION);
}
-/*PAGE
- *
- * _System_state_Is_before_multitasking
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the state is equal to the
* "before multitasking" state, and FALSE otherwise.
*/
@@ -98,12 +81,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_before_multitasking (
return (state == SYSTEM_STATE_BEFORE_MULTITASKING);
}
-/*PAGE
- *
- * _System_state_Is_begin_multitasking
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the state is equal to the
* "begin multitasking" state, and FALSE otherwise.
*/
@@ -115,12 +93,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_begin_multitasking (
return (state == SYSTEM_STATE_BEGIN_MULTITASKING);
}
-/*PAGE
- *
- * _System_state_Is_up
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the state is equal to the
* "up" state, and FALSE otherwise.
*/
@@ -132,12 +105,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_up (
return (state == SYSTEM_STATE_UP);
}
-/*PAGE
- *
- * _System_state_Is_failed
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the state is equal to the
* "failed" state, and FALSE otherwise.
*/
@@ -149,5 +117,7 @@ RTEMS_INLINE_ROUTINE boolean _System_state_Is_failed (
return (state == SYSTEM_STATE_FAILED);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/thread.inl b/cpukit/score/inline/rtems/score/thread.inl
index e4f113f70c..3d38f8e6da 100644
--- a/cpukit/score/inline/rtems/score/thread.inl
+++ b/cpukit/score/inline/rtems/score/thread.inl
@@ -1,9 +1,12 @@
-/* thread.inl
+/**
+ * @file thread.inl
*
* This file contains the macro implementation of the inlined
* routines from the Thread handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __THREAD_inl
#define __THREAD_inl
-/*PAGE
- *
- * _Thread_Stop_multitasking
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreThread
+ * @{
+ */
+
+/**
* This routine halts multitasking and returns control to
* the "thread" (i.e. the BSP) which initially invoked the
* routine which initialized the system.
@@ -32,12 +35,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Stop_multitasking( void )
_Context_Switch( &_Thread_Executing->Registers, &_Thread_BSP_context );
}
-/*PAGE
- *
- * _Thread_Is_executing
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_thread is the currently executing
* thread, and FALSE otherwise.
*/
@@ -49,12 +47,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_executing (
return ( the_thread == _Thread_Executing );
}
-/*PAGE
- *
- * _Thread_Is_heir
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_thread is the heir
* thread, and FALSE otherwise.
*/
@@ -66,12 +59,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_heir (
return ( the_thread == _Thread_Heir );
}
-/*PAGE
- *
- * _Thread_Is_executing_also_the_heir
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the currently executing thread
* is also the heir thread, and FALSE otherwise.
*/
@@ -81,12 +69,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_executing_also_the_heir( void )
return ( _Thread_Executing == _Thread_Heir );
}
-/*PAGE
- *
- * _Thread_Unblock
- *
- * DESCRIPTION:
- *
+/**
* This routine clears any blocking state for the_thread. It performs
* any necessary scheduling operations including the selection of
* a new heir thread.
@@ -99,12 +82,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Unblock (
_Thread_Clear_state( the_thread, STATES_BLOCKED );
}
-/*PAGE
- *
- * _Thread_Restart_self
- *
- * DESCRIPTION:
- *
+/**
* This routine resets the current context of the calling thread
* to that of its initial state.
*/
@@ -119,12 +97,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Restart_self( void )
_CPU_Context_Restart_self( &_Thread_Executing->Registers );
}
-/*PAGE
- *
- * _Thread_Calculate_heir
- *
- * DESCRIPTION:
- *
+/**
* This function returns a pointer to the highest priority
* ready thread.
*/
@@ -135,12 +108,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Calculate_heir( void )
_Thread_Ready_chain[ _Priority_Get_highest() ].first;
}
-/*PAGE
- *
- * _Thread_Is_allocated_fp
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the floating point context of
* the_thread is currently loaded in the floating point unit, and
* FALSE otherwise.
@@ -155,12 +123,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_allocated_fp (
}
#endif
-/*PAGE
- *
- * _Thread_Deallocate_fp
- *
- * DESCRIPTION:
- *
+/**
* This routine is invoked when the currently loaded floating
* point context is now longer associated with an active thread.
*/
@@ -172,12 +135,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Deallocate_fp( void )
}
#endif
-/*PAGE
- *
- * _Thread_Disable_dispatch
- *
- * DESCRIPTION:
- *
+/**
* This routine prevents dispatching.
*/
@@ -186,12 +144,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Disable_dispatch( void )
_Thread_Dispatch_disable_level += 1;
}
-/*PAGE
- *
- * _Thread_Enable_dispatch
- *
- * DESCRIPTION:
- *
+/**
* This routine allows dispatching to occur again. If this is
* the outer most dispatching critical section, then a dispatching
* operation will be performed and, if necessary, control of the
@@ -210,12 +163,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Enable_dispatch()
void _Thread_Enable_dispatch( void );
#endif
-/*PAGE
- *
- * _Thread_Unnest_dispatch
- *
- * DESCRIPTION:
- *
+/**
* This routine allows dispatching to occur again. However,
* no dispatching operation is performed even if this is the outer
* most dispatching critical section.
@@ -226,12 +174,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Unnest_dispatch( void )
_Thread_Dispatch_disable_level -= 1;
}
-/*PAGE
- *
- * _Thread_Is_dispatching_enabled
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if dispatching is disabled, and FALSE
* otherwise.
*/
@@ -241,12 +184,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_dispatching_enabled( void )
return ( _Thread_Dispatch_disable_level == 0 );
}
-/*PAGE
- *
- * _Thread_Is_context_switch_necessary
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if dispatching is disabled, and FALSE
* otherwise.
*/
@@ -256,12 +194,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_context_switch_necessary( void )
return ( _Context_Switch_necessary );
}
-/*PAGE
- *
- * _Thread_Dispatch_initialization
- *
- * DESCRIPTION:
- *
+/**
* This routine initializes the thread dispatching subsystem.
*/
@@ -270,12 +203,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Dispatch_initialization( void )
_Thread_Dispatch_disable_level = 1;
}
-/*PAGE
- *
- * _Thread_Is_null
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_thread is NULL and FALSE otherwise.
*/
@@ -286,12 +214,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_null (
return ( the_thread == NULL );
}
-/*PAGE
- *
- * _Thread_Get
- *
- * DESCRIPTION:
- *
+/**
* This function maps thread IDs to thread control
* blocks. If ID corresponds to a local thread, then it
* returns the_thread control pointer which maps to ID
@@ -301,7 +224,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_null (
* Otherwise, location is set to OBJECTS_ERROR and
* the_thread is undefined.
*
- * NOTE: XXX... This routine may be able to be optimized.
+ * @note XXX... This routine may be able to be optimized.
*/
RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Get (
@@ -347,15 +270,10 @@ done:
}
-/*
- * _Thread_Is_proxy_blocking
+/** @brief _Thread_Is_proxy_blocking
*
- * DESCRIPTION:
- *
- * This function returns TRUE if the status code is equal to the
* status which indicates that a proxy is blocking, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Thread_Is_proxy_blocking (
uint32_t code
)
@@ -363,12 +281,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_Is_proxy_blocking (
return (code == THREAD_STATUS_PROXY_BLOCKING);
}
-/*PAGE
- *
- * _Thread_Internal_allocate
- *
- * DESCRIPTION:
- *
+/**
* This routine allocates an internal thread.
*/
@@ -377,12 +290,7 @@ RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Internal_allocate( void )
return (Thread_Control *) _Objects_Allocate( &_Thread_Internal_information );
}
-/*PAGE
- *
- * _Thread_Internal_free
- *
- * DESCRIPTION:
- *
+/**
* This routine frees an internal thread.
*/
@@ -393,12 +301,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Internal_free (
_Objects_Free( &_Thread_Internal_information, &the_task->Object );
}
-/*PAGE
- *
- * _Thread_Get_libc_reent
- *
- * DESCRIPTION:
- *
+/**
* This routine returns the C library re-enterant pointer.
*/
@@ -407,12 +310,7 @@ RTEMS_INLINE_ROUTINE struct _reent **_Thread_Get_libc_reent( void )
return _Thread_libc_reent;
}
-/*PAGE
- *
- * _Thread_Set_libc_reent
- *
- * DESCRIPTION:
- *
+/**
* This routine set the C library re-enterant pointer.
*/
@@ -423,5 +321,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Set_libc_reent (
_Thread_libc_reent = libc_reent;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/threadmp.inl b/cpukit/score/inline/rtems/score/threadmp.inl
index fbb247c49c..67978a32d7 100644
--- a/cpukit/score/inline/rtems/score/threadmp.inl
+++ b/cpukit/score/inline/rtems/score/threadmp.inl
@@ -1,9 +1,12 @@
-/* inline/threadmp.inl
+/**
+ * @file threadmp.inl
*
* This include file contains the bodies of all inlined routines
* for the multiprocessing part of thread package.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __INLINE_MP_THREAD_inl
#define __INLINE_MP_THREAD_inl
-/*PAGE
- *
- * _Thread_MP_Is_receive
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreThreadMP
+ * @{
+ */
+
+/**
* This function returns true if the thread in question is the
* multiprocessing receive thread.
*/
@@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_MP_Is_receive (
return the_thread == _Thread_MP_Receive;
}
-/*PAGE
- *
- * _Thread_MP_Free_proxy
- *
- * DESCRIPTION:
- *
+/**
* This routine frees a proxy control block to the
* inactive chain of free proxy control blocks.
*/
@@ -56,5 +54,7 @@ RTEMS_INLINE_ROUTINE void _Thread_MP_Free_proxy (
_Chain_Append( &_Thread_MP_Inactive_proxies, &the_thread->Object.Node );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/tod.inl b/cpukit/score/inline/rtems/score/tod.inl
index 7c2a4ffdfc..0854654453 100644
--- a/cpukit/score/inline/rtems/score/tod.inl
+++ b/cpukit/score/inline/rtems/score/tod.inl
@@ -1,9 +1,12 @@
-/* tod.inl
+/**
+ * @file tod.inl
*
* This file contains the static inline implementation of the inlined routines
* from the Time of Day Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __TIME_OF_DAY_inl
#define __TIME_OF_DAY_inl
-/*PAGE
- *
- * _TOD_Tickle_ticks
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreTOD
+ * @{
+ */
+
+/**
* This routine increments the ticks field of the current time of
* day at each clock tick.
*/
@@ -32,12 +35,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Tickle_ticks( void )
_Watchdog_Ticks_since_boot += 1;
}
-/*PAGE
- *
- * _TOD_Deactivate
- *
- * DESCRIPTION:
- *
+/**
* This routine deactivates updating of the current time of day.
*/
@@ -46,12 +44,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Deactivate( void )
_Watchdog_Remove( &_TOD_Seconds_watchdog );
}
-/*PAGE
- *
- * _TOD_Activate
- *
- * DESCRIPTION:
- *
+/**
* This routine activates updating of the current time of day.
*/
@@ -62,5 +55,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Activate(
_Watchdog_Insert_ticks( &_TOD_Seconds_watchdog, ticks );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/tqdata.inl b/cpukit/score/inline/rtems/score/tqdata.inl
index aff81708b8..85662b394d 100644
--- a/cpukit/score/inline/rtems/score/tqdata.inl
+++ b/cpukit/score/inline/rtems/score/tqdata.inl
@@ -1,9 +1,12 @@
-/* tqdata.inl
+/**
+ * @file tqdata.inl
*
* This file contains the static inline implementation of the inlined
* routines needed to support the Thread Queue Data.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -13,15 +16,15 @@
* $Id$
*/
-#ifndef __THREAD_QUEUE_DATA_inl
-#define __THREAD_QUEUE_DATA_inl
+#ifndef __THREAD_QUEUE_inl
+#define __THREAD_QUEUE_inl
-/*PAGE
- *
- * _Thread_queue_Header_number
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreThreadQ
+ * @{
+ */
+
+/**
* This function returns the index of the priority chain on which
* a thread of the_priority should be placed.
*/
@@ -33,12 +36,7 @@ RTEMS_INLINE_ROUTINE uint32_t _Thread_queue_Header_number (
return (the_priority / TASK_QUEUE_DATA_PRIORITIES_PER_HEADER);
}
-/*PAGE
- *
- * _Thread_queue_Is_reverse_search
- *
- * DESCRIPTION:
- *
+/**
* This function returns TRUE if the_priority indicates that the
* enqueue search should start at the front of this priority
* group chain, and FALSE if the search should start at the rear.
@@ -51,12 +49,7 @@ RTEMS_INLINE_ROUTINE boolean _Thread_queue_Is_reverse_search (
return ( the_priority & TASK_QUEUE_DATA_REVERSE_SEARCH_MASK );
}
-/*PAGE
- *
- * _Thread_queue_Enter_critical_section
- *
- * DESCRIPTION:
- *
+/**
* This routine is invoked to indicate that the specified thread queue is
* entering a critical section.
*/
diff --git a/cpukit/score/inline/rtems/score/userext.inl b/cpukit/score/inline/rtems/score/userext.inl
index 2aef8001ff..205968d5dc 100644
--- a/cpukit/score/inline/rtems/score/userext.inl
+++ b/cpukit/score/inline/rtems/score/userext.inl
@@ -1,9 +1,12 @@
-/* userext.inl
+/**
+ * @file userext.inl
*
* This file contains the macro implementation of the inlined routines
* from the User Extension Handler
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -18,15 +21,15 @@
#include <rtems/score/wkspace.h>
-/*PAGE
- *
- * _User_extensions_Add_set
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreUserExt
+ * @{
+ */
+
+/**
* This routine is used to add a user extension set to the active list.
*
- * NOTE: Must be before _User_extensions_Handler_initialization to
+ * @note Must be before _User_extensions_Handler_initialization to
* ensure proper inlining.
*/
@@ -49,12 +52,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Add_set (
}
}
-/*PAGE
- *
- * _User_extensions_Handler_initialization
- *
- * DESCRIPTION:
- *
+/**
* This routine performs the initialization necessary for this handler.
*/
@@ -88,12 +86,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Handler_initialization (
}
}
-/*PAGE
- *
- * _User_extensions_Add_API_set
- *
- * DESCRIPTION:
- *
+/**
* This routine is used to add an API extension set to the active list.
*/
@@ -114,12 +107,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Add_API_set (
}
}
-/*PAGE
- *
- * _User_extensions_Remove_set
- *
- * DESCRIPTION:
- *
+/**
* This routine is used to remove a user extension set from the active list.
*/
@@ -137,12 +125,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Remove_set (
_Chain_Extract( &the_extension->Switch.Node );
}
-/*PAGE
- *
- * _User_extensions_Thread_switch
- *
- * DESCRIPTION:
- *
+/**
* This routine is used to invoke the user extension which
* is invoked when a context switch occurs.
*/
@@ -165,5 +148,7 @@ RTEMS_INLINE_ROUTINE void _User_extensions_Thread_switch (
}
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/watchdog.inl b/cpukit/score/inline/rtems/score/watchdog.inl
index aace2123a6..4aebc4b34b 100644
--- a/cpukit/score/inline/rtems/score/watchdog.inl
+++ b/cpukit/score/inline/rtems/score/watchdog.inl
@@ -1,9 +1,12 @@
-/* watchdog.inl
+/**
+ * @file watchdog.inl
*
* This file contains the static inline implementation of all inlined
* routines in the Watchdog Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __WATCHDOG_inl
#define __WATCHDOG_inl
-/*PAGE
- *
- * _Watchdog_Initialize
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreWatchdog
+ * @{
+ */
+
+/**
* This routine initializes the specified watchdog. The watchdog is
* made inactive, the watchdog id and handler routine are set to the
* specified values.
@@ -40,12 +43,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Initialize(
the_watchdog->user_data = user_data;
}
-/*PAGE
- *
- * _Watchdog_Is_active
- *
- * DESCRIPTION:
- *
+/**
* This routine returns TRUE if the watchdog timer is in the ACTIVE
* state, and FALSE otherwise.
*/
@@ -59,12 +57,7 @@ RTEMS_INLINE_ROUTINE boolean _Watchdog_Is_active(
}
-/*PAGE
- *
- * _Watchdog_Activate
- *
- * DESCRIPTION:
- *
+/**
* This routine activates THE_WATCHDOG timer which is already
* on a watchdog chain.
*/
@@ -78,12 +71,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Activate(
}
-/*PAGE
- *
- * _Watchdog_Deactivate
- *
- * DESCRIPTION:
- *
+/**
* This routine deactivates THE_WATCHDOG timer which will remain
* on a watchdog chain.
*/
@@ -97,12 +85,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Deactivate(
}
-/*PAGE
- *
- * _Watchdog_Tickle_ticks
- *
- * DESCRIPTION:
- *
+/**
* This routine is invoked at each clock tick to update the ticks
* watchdog chain.
*/
@@ -114,12 +97,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Tickle_ticks( void )
}
-/*PAGE
- *
- * _Watchdog_Tickle_seconds
- *
- * DESCRIPTION:
- *
+/**
* This routine is invoked at each clock tick to update the seconds
* watchdog chain.
*/
@@ -131,12 +109,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Tickle_seconds( void )
}
-/*PAGE
- *
- * _Watchdog_Insert_ticks
- *
- * DESCRIPTION:
- *
+/**
* This routine inserts THE_WATCHDOG into the ticks watchdog chain
* for a time of UNITS ticks. The INSERT_MODE indicates whether
* THE_WATCHDOG is to be activated automatically or later, explicitly
@@ -155,12 +128,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Insert_ticks(
}
-/*PAGE
- *
- * _Watchdog_Insert_seconds
- *
- * DESCRIPTION:
- *
+/**
* This routine inserts THE_WATCHDOG into the seconds watchdog chain
* for a time of UNITS seconds. The INSERT_MODE indicates whether
* THE_WATCHDOG is to be activated automatically or later, explicitly
@@ -179,12 +147,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Insert_seconds(
}
-/*PAGE
- *
- * _Watchdog_Adjust_seconds
- *
- * DESCRIPTION:
- *
+/**
* This routine adjusts the seconds watchdog chain in the forward
* or backward DIRECTION for UNITS seconds. This is invoked when the
* current time of day is changed.
@@ -200,12 +163,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Adjust_seconds(
}
-/*PAGE
- *
- * _Watchdog_Adjust_ticks
- *
- * DESCRIPTION:
- *
+/**
* This routine adjusts the ticks watchdog chain in the forward
* or backward DIRECTION for UNITS ticks.
*/
@@ -220,12 +178,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Adjust_ticks(
}
-/*PAGE
- *
- * _Watchdog_Reset
- *
- * DESCRIPTION:
- *
+/**
* This routine resets THE_WATCHDOG timer to its state at INSERT
* time. This routine is valid only on interval watchdog timers
* and is used to make an interval watchdog timer fire "every" so
@@ -243,12 +196,7 @@ RTEMS_INLINE_ROUTINE void _Watchdog_Reset(
}
-/*PAGE
- *
- * _Watchdog_Next
- *
- * DESCRIPTION:
- *
+/**
* This routine returns a pointer to the watchdog timer following
* THE_WATCHDOG on the watchdog chain.
*/
@@ -262,12 +210,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Next(
}
-/*PAGE
- *
- * _Watchdog_Previous
- *
- * DESCRIPTION:
- *
+/**
* This routine returns a pointer to the watchdog timer preceding
* THE_WATCHDOG on the watchdog chain.
*/
@@ -281,12 +224,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Previous(
}
-/*PAGE
- *
- * _Watchdog_First
- *
- * DESCRIPTION:
- *
+/**
* This routine returns a pointer to the first watchdog timer
* on the watchdog chain HEADER.
*/
@@ -300,12 +238,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_First(
}
-/*PAGE
- *
- * _Watchdog_Last
- *
- * DESCRIPTION:
- *
+/**
* This routine returns a pointer to the last watchdog timer
* on the watchdog chain HEADER.
*/
@@ -319,5 +252,7 @@ RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Last(
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/wkspace.inl b/cpukit/score/inline/rtems/score/wkspace.inl
index baa6297220..d9bd16eed3 100644
--- a/cpukit/score/inline/rtems/score/wkspace.inl
+++ b/cpukit/score/inline/rtems/score/wkspace.inl
@@ -1,9 +1,12 @@
-/* wkspace.inl
+/**
+ * @file wkspace.inl
*
* This include file contains the bodies of the routines which contains
* information related to the RAM Workspace.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2004.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
#ifndef __WORKSPACE_inl
#define __WORKSPACE_inl
-/*PAGE
- *
- * _Workspace_Allocate
- *
- * DESCRIPTION:
- *
+/**
+ * @addtogroup ScoreWorkspace
+ * @{
+ */
+
+/**
* This routine returns the address of a block of memory of size
* bytes. If a block of the appropriate size cannot be allocated
* from the workspace, then NULL is returned.
@@ -34,12 +37,7 @@ RTEMS_INLINE_ROUTINE void *_Workspace_Allocate(
return _Heap_Allocate( &_Workspace_Area, size );
}
-/*PAGE
- *
- * _Workspace_Free
- *
- * DESCRIPTION:
- *
+/**
* This function frees the specified block of memory. If the block
* belongs to the Workspace and can be successfully freed, then
* TRUE is returned. Otherwise FALSE is returned.
@@ -52,5 +50,7 @@ RTEMS_INLINE_ROUTINE boolean _Workspace_Free(
return _Heap_Free( &_Workspace_Area, block );
}
+/**@}*/
+
#endif
/* end of include file */