summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include
diff options
context:
space:
mode:
authorRalf Corsepius <ralf.corsepius@rtems.org>2008-12-22 06:05:34 +0000
committerRalf Corsepius <ralf.corsepius@rtems.org>2008-12-22 06:05:34 +0000
commitc6b37199d93a9d74d2ce631f177e01d308193be5 (patch)
treee80d667c7da4f0c56c3e7a0f0995753effaaefa8 /cpukit/score/include
parent2008-12-22 Ralf Corsépius <ralf.corsepius@rtems.org> (diff)
downloadrtems-c6b37199d93a9d74d2ce631f177e01d308193be5.tar.bz2
Eliminate TRUE/FALSE.
Diffstat (limited to 'cpukit/score/include')
-rw-r--r--cpukit/score/include/rtems/score/context.h4
-rw-r--r--cpukit/score/include/rtems/score/corebarrier.h4
-rw-r--r--cpukit/score/include/rtems/score/coremsg.h6
-rw-r--r--cpukit/score/include/rtems/score/coremutex.h10
-rw-r--r--cpukit/score/include/rtems/score/corerwlock.h8
-rw-r--r--cpukit/score/include/rtems/score/coresem.h4
-rw-r--r--cpukit/score/include/rtems/score/heap.h10
-rw-r--r--cpukit/score/include/rtems/score/isr.h6
-rw-r--r--cpukit/score/include/rtems/score/object.h10
-rw-r--r--cpukit/score/include/rtems/score/objectmp.h2
-rw-r--r--cpukit/score/include/rtems/score/protectedheap.h14
-rw-r--r--cpukit/score/include/rtems/score/thread.h2
-rw-r--r--cpukit/score/include/rtems/score/threadq.h2
-rw-r--r--cpukit/score/include/rtems/score/tod.h4
-rw-r--r--cpukit/score/include/rtems/score/userext.h4
-rw-r--r--cpukit/score/include/rtems/score/wkspace.h4
16 files changed, 47 insertions, 47 deletions
diff --git a/cpukit/score/include/rtems/score/context.h b/cpukit/score/include/rtems/score/context.h
index 40b06a4e0c..fe78e6c26c 100644
--- a/cpukit/score/include/rtems/score/context.h
+++ b/cpukit/score/include/rtems/score/context.h
@@ -43,7 +43,7 @@ extern "C" {
/**
* @brief Is Context Switch Needed?
*
- * This variable is set to TRUE when a reschedule operation
+ * This variable is set to true when a reschedule operation
* has determined that the processor should be taken away from the
* currently executing thread and given to the heir thread.
*/
@@ -62,7 +62,7 @@ SCORE_EXTERN volatile bool _Context_Switch_necessary;
* @param[in] _size is the size in octets of the thread's context
* @param[in] _isr is the ISR enable level for this thread
* @param[in] _entry is this thread's entry point
- * @param[in] _is_fp is set to TRUE if this thread has floating point
+ * @param[in] _is_fp is set to true if this thread has floating point
* enabled
*/
#define _Context_Initialize(_the_context, _stack, _size, _isr, _entry, _is_fp) \
diff --git a/cpukit/score/include/rtems/score/corebarrier.h b/cpukit/score/include/rtems/score/corebarrier.h
index b66d95aaf6..e7cd83cfbc 100644
--- a/cpukit/score/include/rtems/score/corebarrier.h
+++ b/cpukit/score/include/rtems/score/corebarrier.h
@@ -139,9 +139,9 @@ void _CORE_barrier_Initialize(
*
* @param[in] the_barrier is the barrier to wait for
* @param[in] id is the id of the object being waited upon
- * @param[in] wait is TRUE if the calling thread is willing to wait
+ * @param[in] wait is true if the calling thread is willing to wait
* @param[in] timeout is the number of ticks the calling thread is willing
- * to wait if @a wait is TRUE.
+ * to wait if @a wait is true.
* @param[in] api_barrier_mp_support is the routine to invoke if the
* thread unblocked is remote
*
diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index 74a9c2beea..4ccbf06987 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -236,8 +236,8 @@ typedef struct {
* @param[in] maximum_message_size is the size of largest message that
* may be sent to this message queue instance
*
- * @return TRUE if the message queue can be initialized. In general,
- * FALSE will only be returned if memory for the pending
+ * @return true if the message queue can be initialized. In general,
+ * false will only be returned if memory for the pending
* messages cannot be allocated.
*/
bool _CORE_message_queue_Initialize(
@@ -374,7 +374,7 @@ CORE_message_queue_Status _CORE_message_queue_Submit(
*
* This kernel routine dequeues a message, copies the message buffer to
* a given destination buffer, and frees the message buffer to the
- * inactive message pool. The thread will be blocked if wait is TRUE,
+ * inactive message pool. The thread will be blocked if wait is true,
* otherwise an error will be given to the thread if no messages are available.
*
* @param[in] the_message_queue points to the message queue
diff --git a/cpukit/score/include/rtems/score/coremutex.h b/cpukit/score/include/rtems/score/coremutex.h
index 01414e0914..73a68189d8 100644
--- a/cpukit/score/include/rtems/score/coremutex.h
+++ b/cpukit/score/include/rtems/score/coremutex.h
@@ -178,7 +178,7 @@ typedef struct {
* be when attempting to acquire the mutex when it is already locked.
*/
CORE_mutex_Nesting_behaviors lock_nesting_behavior;
- /** When this field is TRUE, then only the thread that locked the mutex
+ /** When this field is true, then only the thread that locked the mutex
* is allowed to unlock it.
*/
bool only_owner_release;
@@ -269,7 +269,7 @@ void _CORE_mutex_Initialize(
* @brief Seize Mutex with Quick Success Path
*
* This routine attempts to receive a unit from the_mutex.
- * If a unit is available or if the wait flag is FALSE, then the routine
+ * 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.
*
@@ -340,7 +340,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
*
* @param[in] _the_mutex is the mutex to attempt to lock
* @param[in] _id is the Id of the owning API level Semaphore object
- * @param[in] _wait is TRUE if the thread is willing to wait
+ * @param[in] _wait is true if the thread is willing to wait
* @param[in] _timeout is the maximum number of ticks to block
* @param[in] _level is a temporary variable used to contain the ISR
* disable level cookie
@@ -368,7 +368,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
) { \
_Internal_error_Occurred( \
INTERNAL_ERROR_CORE, \
- FALSE, \
+ false, \
INTERNAL_ERROR_MUTEX_OBTAIN_FROM_BAD_STATE \
); \
} \
@@ -393,7 +393,7 @@ void _CORE_mutex_Seize_interrupt_blocking(
*
* @param[in] _the_mutex is the mutex to attempt to lock
* @param[in] _id is the Id of the owning API level Semaphore object
- * @param[in] _wait is TRUE if the thread is willing to wait
+ * @param[in] _wait is true if the thread is willing to wait
* @param[in] _timeout is the maximum number of ticks to block
* @param[in] _level is a temporary variable used to contain the ISR
* disable level cookie
diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h
index 7e1e3d8994..6a636c8029 100644
--- a/cpukit/score/include/rtems/score/corerwlock.h
+++ b/cpukit/score/include/rtems/score/corerwlock.h
@@ -140,9 +140,9 @@ void _CORE_RWLock_Initialize(
*
* @param[in] the_rwlock is the RWLock to wait for
* @param[in] id is the id of the object being waited upon
- * @param[in] wait is TRUE if the calling thread is willing to wait
+ * @param[in] wait is true if the calling thread is willing to wait
* @param[in] timeout is the number of ticks the calling thread is willing
- * to wait if @a wait is TRUE.
+ * to wait if @a wait is true.
* @param[in] api_rwlock_mp_support is the routine to invoke if the
* thread unblocked is remote
*
@@ -161,9 +161,9 @@ void _CORE_RWLock_Obtain_for_reading(
*
* @param[in] the_rwlock is the RWLock to wait for
* @param[in] id is the id of the object being waited upon
- * @param[in] wait is TRUE if the calling thread is willing to wait
+ * @param[in] wait is true if the calling thread is willing to wait
* @param[in] timeout is the number of ticks the calling thread is willing
- * to wait if @a wait is TRUE.
+ * to wait if @a wait is true.
* @param[in] api_rwlock_mp_support is the routine to invoke if the
* thread unblocked is remote
*
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index 3614643615..39cb20bdc3 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -137,7 +137,7 @@ void _CORE_semaphore_Initialize(
/**
* This routine attempts to receive a unit from @a the_semaphore.
- * If a unit is available or if the wait flag is FALSE, then the routine
+ * 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.
*
@@ -146,7 +146,7 @@ void _CORE_semaphore_Initialize(
* with this instance of a SuperCore Semaphore
* @param[in] wait indicates if the caller is willing to block
* @param[in] timeout is the number of ticks the calling thread is willing
- * to wait if @a wait is TRUE.
+ * to wait if @a wait is true.
*/
void _CORE_semaphore_Seize(
CORE_semaphore_Control *the_semaphore,
diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h
index 286205dffc..7418e0c1ea 100644
--- a/cpukit/score/include/rtems/score/heap.h
+++ b/cpukit/score/include/rtems/score/heap.h
@@ -323,14 +323,14 @@ void *_Heap_Allocate_aligned(
* This function sets @a *size to the size of the block of user memory
* which begins at @a starting_address. The size returned in @a *size could
* be greater than the size requested for allocation.
- * Returns TRUE if the @a starting_address is in the heap, and FALSE
+ * Returns true if the @a starting_address is in the heap, and false
* otherwise.
*
* @param[in] the_heap is the heap to operate upon
* @param[in] starting_address is the starting address of the user block
* to obtain the size of
* @param[in] size points to a user area to return the size in
- * @return TRUE if successfully able to determine the size, FALSE otherwise
+ * @return true if successfully able to determine the size, false otherwise
* @return *size filled in with the size of the user area for this block
*/
bool _Heap_Size_of_user_area(
@@ -377,7 +377,7 @@ Heap_Resize_status _Heap_Resize_block(
* @param[in] the_heap is the heap to operate upon
* @param[in] start_address is the starting address of the user block
* to free
- * @return TRUE if successfully freed, FALSE otherwise
+ * @return true if successfully freed, false otherwise
*/
bool _Heap_Free(
Heap_Control *the_heap,
@@ -390,8 +390,8 @@ bool _Heap_Free(
* @param[in] the_heap is the heap to operate upon
* @param[in] source is a user specified integer which may be used to
* indicate where in the application this was invoked from
- * @param[in] do_dump is set to TRUE if errors should be printed
- * @return TRUE if the test passed fine, FALSE otherwise.
+ * @param[in] do_dump is set to true if errors should be printed
+ * @return true if the test passed fine, false otherwise.
*/
bool _Heap_Walk(
Heap_Control *the_heap,
diff --git a/cpukit/score/include/rtems/score/isr.h b/cpukit/score/include/rtems/score/isr.h
index d81bef5766..ae04c9f8f0 100644
--- a/cpukit/score/include/rtems/score/isr.h
+++ b/cpukit/score/include/rtems/score/isr.h
@@ -76,7 +76,7 @@ typedef ISR_Handler ( *ISR_Handler_entry )(
#define ISR_INTERRUPT_MAXIMUM_VECTOR_NUMBER CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER
/**
- * The following is TRUE if signals have been sent to the currently
+ * The following is true if signals have been sent to the currently
* executing thread by an ISR handler.
*/
SCORE_EXTERN bool _ISR_Signals_to_thread_executing;
@@ -196,8 +196,8 @@ void _ISR_Handler( void );
void _ISR_Dispatch( void );
/**
- * This function returns TRUE if the processor is currently servicing
- * and interrupt and FALSE otherwise. A return value of TRUE indicates
+ * This function returns true if the processor is currently servicing
+ * and interrupt and false otherwise. A return value of true indicates
* that the caller is an interrupt service routine, NOT a thread. The
*/
#if (CPU_PROVIDES_ISR_IS_IN_PROGRESS == TRUE)
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 6a746501a6..af46659069 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -333,7 +333,7 @@ typedef struct {
Objects_Id maximum_id;
/** This is the maximum number of objects in this class. */
Objects_Maximum maximum;
- /** This is the TRUE if unlimited objects in this class. */
+ /** This is the true if unlimited objects in this class. */
bool auto_extend;
/** This is the number of objects in a block. */
uint32_t allocation_size;
@@ -454,8 +454,8 @@ void _Objects_Shrink_information(
/**
* This function initializes an object class information record.
- * SUPPORTS_GLOBAL is TRUE if the object class supports global
- * objects, and FALSE otherwise. Maximum indicates the number
+ * SUPPORTS_GLOBAL is true if the object class supports global
+ * objects, and false otherwise. Maximum indicates the number
* of objects required in this class and size indicates the size
* in bytes of each control block for this object class. The
* name length and string designator are also set. In addition,
@@ -468,7 +468,7 @@ void _Objects_Shrink_information(
* @param[in] maximum is the maximum number of instances of this object
* class which may be concurrently active.
* @param[in] size is the size of the data structure for this class.
- * @param[in] is_string is TRUE if this object uses string style names.
+ * @param[in] is_string is true if this object uses string style names.
* @param[in] maximum_name_length is the maximum length of object names.
*/
void _Objects_Initialize_information (
@@ -836,7 +836,7 @@ char *_Objects_Get_name_as_string(
* @param[in] the_object is the object to operate upon
* @param[in] name is a pointer to the name to use
*
- * @return If successful, TRUE is returned. Otherwise FALSE is returned.
+ * @return If successful, true is returned. Otherwise false is returned.
*/
bool _Objects_Set_name(
Objects_Information *information,
diff --git a/cpukit/score/include/rtems/score/objectmp.h b/cpukit/score/include/rtems/score/objectmp.h
index 5c47659ee1..03605f49d7 100644
--- a/cpukit/score/include/rtems/score/objectmp.h
+++ b/cpukit/score/include/rtems/score/objectmp.h
@@ -85,7 +85,7 @@ void _Objects_MP_Open (
* object class.
* @param[in] the_name is the name of the object being opened.
* @param[in] the_id is the Id of the object being opened.
- * @param[in] is_fatal_error is TRUE if not being able to allocate the
+ * @param[in] is_fatal_error is true if not being able to allocate the
* object is considered a fatal error.
*
* @todo This method only works for object types with 4 byte object names.
diff --git a/cpukit/score/include/rtems/score/protectedheap.h b/cpukit/score/include/rtems/score/protectedheap.h
index 1d71ac9b3f..be657155ae 100644
--- a/cpukit/score/include/rtems/score/protectedheap.h
+++ b/cpukit/score/include/rtems/score/protectedheap.h
@@ -115,14 +115,14 @@ void *_Protected_heap_Allocate_aligned(
* This function sets @a *size to the size of the block of user memory
* which begins at @a starting_address. The size returned in @a *size could
* be greater than the size requested for allocation.
- * Returns TRUE if the @a starting_address is in the heap, and FALSE
+ * Returns true if the @a starting_address is in the heap, and false
* otherwise.
*
* @param[in] the_heap is the heap to operate upon
* @param[in] starting_address is the starting address of the user block
* to obtain the size of
* @param[in] size points to a user area to return the size in
- * @return TRUE if successfully able to determine the size, FALSE otherwise
+ * @return true if successfully able to determine the size, false otherwise
* @return *size filled in with the size of the user area for this block
*/
bool _Protected_heap_Get_block_size(
@@ -140,8 +140,8 @@ bool _Protected_heap_Get_block_size(
* to be resized
* @param[in] size is the new size
*
- * @return TRUE if successfully able to resize the block.
- * FALSE if the block can't be resized in place.
+ * @return true if successfully able to resize the block.
+ * false if the block can't be resized in place.
*/
bool _Protected_heap_Resize_block(
Heap_Control *the_heap,
@@ -157,7 +157,7 @@ bool _Protected_heap_Resize_block(
* @param[in] the_heap is the heap to operate upon
* @param[in] start_address is the starting address of the user block
* to free
- * @return TRUE if successfully freed, FALSE otherwise
+ * @return true if successfully freed, false otherwise
*/
bool _Protected_heap_Free(
Heap_Control *the_heap,
@@ -170,8 +170,8 @@ bool _Protected_heap_Free(
* @param[in] the_heap is the heap to operate upon
* @param[in] source is a user specified integer which may be used to
* indicate where in the application this was invoked from
- * @param[in] do_dump is set to TRUE if errors should be printed
- * @return TRUE if the test passed fine, FALSE otherwise.
+ * @param[in] do_dump is set to true if errors should be printed
+ * @return true if the test passed fine, false otherwise.
*/
bool _Protected_heap_Walk(
Heap_Control *the_heap,
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index fc106240a3..b9355f0ee1 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -751,7 +751,7 @@ void _Thread_Suspend(
/**
* This routine updates the related suspend fields in the_thread
* control block to indicate the current nested level. A force
- * parameter of TRUE will force a resume and clear the suspend count.
+ * parameter of true will force a resume and clear the suspend count.
*/
void _Thread_Resume(
Thread_Control *the_thread,
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index 3995107b76..5da779983f 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -202,7 +202,7 @@ void _Thread_queue_Extract_priority_helper(
*/
#define _Thread_queue_Extract_priority( _the_thread_queue, _the_thread ) \
- _Thread_queue_Extract_priority_helper( _the_thread_queue, _the_thread, FALSE )
+ _Thread_queue_Extract_priority_helper( _the_thread_queue, _the_thread, false )
/** @brief Thread queue First priority
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index 31da246226..a19c7686f4 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -118,8 +118,8 @@ extern "C" {
/** @brief Is the Time Of Day Set
*
- * This is TRUE if the application has set the current
- * time of day, and FALSE otherwise.
+ * This is true if the application has set the current
+ * time of day, and false otherwise.
*/
SCORE_EXTERN bool _TOD_Is_set;
diff --git a/cpukit/score/include/rtems/score/userext.h b/cpukit/score/include/rtems/score/userext.h
index 6c0c41164e..938630eb0e 100644
--- a/cpukit/score/include/rtems/score/userext.h
+++ b/cpukit/score/include/rtems/score/userext.h
@@ -244,7 +244,7 @@ void _User_extensions_Remove_set (
*
* @param[in] the_thread is the thread being created.
*
- * @return This method returns TRUE if the user extension executed
+ * @return This method returns true if the user extension executed
* successfully.
*/
bool _User_extensions_Thread_create (
@@ -326,7 +326,7 @@ void _User_extensions_Thread_exitted (
* when a fatal error occurs.
*
* @param[in] the_source is the source of the fatal error.
- * @param[in] is_internal is TRUE if the error originated inside RTEMS.
+ * @param[in] is_internal is true if the error originated inside RTEMS.
* @param[in] the_error is an indication of the actual error.
*/
void _User_extensions_Fatal (
diff --git a/cpukit/score/include/rtems/score/wkspace.h b/cpukit/score/include/rtems/score/wkspace.h
index 94979c6b9b..58648a750e 100644
--- a/cpukit/score/include/rtems/score/wkspace.h
+++ b/cpukit/score/include/rtems/score/wkspace.h
@@ -66,11 +66,11 @@ void *_Workspace_Allocate(
*
* 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.
+ * true is returned. Otherwise false is returned.
*
* @param block is the memory to free
*
- * @return TRUE if the free was successful.
+ * @return true if the free was successful.
*/
bool _Workspace_Free(