From f9293dfaf13a21fcb3bf285159d37211ceeb1c4c Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 18 Apr 2008 20:08:08 +0000 Subject: 2008-04-18 Joel Sherrill * rtems/Doxyfile, 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/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/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/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/timer.inl: More Doxygen improvements. --- cpukit/rtems/include/rtems/rtems/asr.h | 20 ++-- cpukit/rtems/include/rtems/rtems/attr.h | 131 ++++++++++++++++++++++++--- cpukit/rtems/include/rtems/rtems/barrier.h | 8 +- cpukit/rtems/include/rtems/rtems/barriermp.h | 2 +- cpukit/rtems/include/rtems/rtems/cache.h | 2 +- cpukit/rtems/include/rtems/rtems/config.h | 2 +- cpukit/rtems/include/rtems/rtems/dpmem.h | 8 +- cpukit/rtems/include/rtems/rtems/event.h | 6 ++ cpukit/rtems/include/rtems/rtems/eventmp.h | 2 +- cpukit/rtems/include/rtems/rtems/eventset.h | 13 ++- cpukit/rtems/include/rtems/rtems/intr.h | 2 +- cpukit/rtems/include/rtems/rtems/message.h | 25 ++++- cpukit/rtems/include/rtems/rtems/modes.h | 48 +++++++--- cpukit/rtems/include/rtems/rtems/mp.h | 2 +- cpukit/rtems/include/rtems/rtems/msgmp.h | 2 +- cpukit/rtems/include/rtems/rtems/options.h | 29 +++++- cpukit/rtems/include/rtems/rtems/part.h | 8 +- cpukit/rtems/include/rtems/rtems/partmp.h | 2 +- cpukit/rtems/include/rtems/rtems/ratemon.h | 8 +- cpukit/rtems/include/rtems/rtems/region.h | 8 +- cpukit/rtems/include/rtems/rtems/regionmp.h | 2 +- cpukit/rtems/include/rtems/rtems/rtemsapi.h | 8 +- cpukit/rtems/include/rtems/rtems/sem.h | 8 +- cpukit/rtems/include/rtems/rtems/semmp.h | 4 +- cpukit/rtems/include/rtems/rtems/signal.h | 2 +- cpukit/rtems/include/rtems/rtems/signalmp.h | 2 +- cpukit/rtems/include/rtems/rtems/status.h | 2 +- cpukit/rtems/include/rtems/rtems/support.h | 6 +- cpukit/rtems/include/rtems/rtems/taskmp.h | 2 +- cpukit/rtems/include/rtems/rtems/tasks.h | 8 +- cpukit/rtems/include/rtems/rtems/timer.h | 8 +- cpukit/rtems/include/rtems/rtems/types.h | 2 +- 32 files changed, 301 insertions(+), 81 deletions(-) (limited to 'cpukit/rtems/include/rtems/rtems') diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h index 4fcade6d28..1d5ba6194f 100644 --- a/cpukit/rtems/include/rtems/rtems/asr.h +++ b/cpukit/rtems/include/rtems/rtems/asr.h @@ -6,7 +6,7 @@ * support required by the Signal Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -56,12 +56,18 @@ typedef rtems_asr ( *rtems_asr_entry )( * signals. Each thread has a copy of this record. */ typedef struct { - boolean is_enabled; /* are ASRs enabled currently? */ - rtems_asr_entry handler; /* address of RTEMS_ASR */ - Modes_Control mode_set; /* RTEMS_ASR mode */ - rtems_signal_set signals_posted; /* signal set */ - rtems_signal_set signals_pending; /* pending signal set */ - uint32_t nest_level; /* nest level of RTEMS_ASR */ + /** This field indicates if are ASRs enabled currently. */ + boolean is_enabled; + /** This field indicates if address of the signal handler function. */ + rtems_asr_entry handler; + /** This field indicates if the task mode the signal will run with. */ + Modes_Control mode_set; + /** This field indicates the signal set that is posted. */ + rtems_signal_set signals_posted; + /** This field indicates the signal set that is pending. */ + rtems_signal_set signals_pending; + /** This field indicates if nest level of signals being processed */ + uint32_t nest_level; } ASR_Information; /* diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h index 8c1bf99b2d..23ddce1bad 100644 --- a/cpukit/rtems/include/rtems/rtems/attr.h +++ b/cpukit/rtems/include/rtems/rtems/attr.h @@ -5,7 +5,7 @@ * Handler. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -29,51 +29,152 @@ extern "C" { */ /**@{*/ -/* types */ - +/** + * This defines the type used to contain Classic API attributes. These + * are primarily used when creating objects. + */ typedef uint32_t rtems_attribute; -/* constants */ +/** This is the default value for an attribute set. */ #define RTEMS_DEFAULT_ATTRIBUTES 0x00000000 -#define RTEMS_LOCAL 0x00000000 /* local resource */ -#define RTEMS_GLOBAL 0x00000002 /* global resource */ +/** + * This is the attribute constant to indicate local resource. + */ +#define RTEMS_LOCAL 0x00000000 -#define RTEMS_FIFO 0x00000000 /* process RTEMS_FIFO */ -#define RTEMS_PRIORITY 0x00000004 /* process by priority */ +/** + * This is the attribute constant to indicate global resource. + */ +#define RTEMS_GLOBAL 0x00000002 - /* RTEMS Task Specific Attributes */ -#define RTEMS_NO_FLOATING_POINT 0x00000000 /* don't use FP HW */ -#define RTEMS_FLOATING_POINT 0x00000001 /* utilize coprocessor */ +/** + * This is the attribute constant which reflects that blocking + * tasks will be managed using FIFO discipline. + */ +#define RTEMS_FIFO 0x00000000 - /* RTEMS Semaphore Specific Attributes */ -#define RTEMS_SEMAPHORE_CLASS 0x00000030 /* mask */ +/** + * This is the attribute constant which reflects that blocking + * tasks will be managed using task priority discipline. + */ +#define RTEMS_PRIORITY 0x00000004 + +/******************** RTEMS Task Specific Attributes *********************/ + +/** + * This attribute constant indicates that the task will not use the + * floating point hardware. If the architecture permits it, then + * the FPU will be disabled when the task is executing. + */ +#define RTEMS_NO_FLOATING_POINT 0x00000000 + +/** + * This attribute constant indicates that the task will use the + * floating point hardware. There will be a floating point + * context associated with this task. + */ +#define RTEMS_FLOATING_POINT 0x00000001 + +/***************** RTEMS Semaphore Specific Attributes ********************/ + +/** + * This is the mask for the attribute bits associated with the + * Classic API Semaphore Manager. + */ +#define RTEMS_SEMAPHORE_CLASS 0x00000030 + +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will be a counting semaphore. + */ #define RTEMS_COUNTING_SEMAPHORE 0x00000000 + +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will be a proper binary semaphore or mutex. + */ #define RTEMS_BINARY_SEMAPHORE 0x00000010 + +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will be a simple binary semaphore. + */ #define RTEMS_SIMPLE_BINARY_SEMAPHORE 0x00000020 +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will NOT use the Priority Inheritance Protocol. + */ #define RTEMS_NO_INHERIT_PRIORITY 0x00000000 + +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will use the Priority Inheritance Protocol. + * + * @note The semaphore instance must be a binary semaphore. + */ #define RTEMS_INHERIT_PRIORITY 0x00000040 +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will NOT use the Priority Ceiling Protocol. + */ #define RTEMS_NO_PRIORITY_CEILING 0x00000000 + +/** + * This attribute constant indicates that the Classic API Semaphore + * instance created will use the Priority Ceiling Protocol. + * + * @note The semaphore instance must be a binary semaphore. + */ #define RTEMS_PRIORITY_CEILING 0x00000080 - /* RTEMS Barrier Specific Attributes */ +/******************** RTEMS Barrier Specific Attributes ********************/ + +/** + * This attribute constant indicates that the Classic API Barrier + * instance created will use an automatic release protocol. + */ #define RTEMS_BARRIER_AUTOMATIC_RELEASE 0x00000010 + +/** + * This attribute constant indicates that the Classic API Barrier + * instance created will use the manual release protocol. + */ #define RTEMS_BARRIER_MANUAL_RELEASE 0x00000000 - /* RTEMS Internal Task Specific Attributes */ +/**************** RTEMS Internal Task Specific Attributes ****************/ + +/** + * This attribute constant indicates that the task was created + * by the application using normal Classic API methods. + */ #define RTEMS_APPLICATION_TASK 0x00000000 + +/** + * This attribute constant indicates that the task was created + * by RTEMS as a support task. + */ #define RTEMS_SYSTEM_TASK 0x00008000 +/****************** Forced Attributes in Configuration ****************/ +/** + * This attribute constant indicates the attributes that are not + * supportable given the hardware configuration. + */ #if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE ) #define ATTRIBUTES_NOT_SUPPORTED 0 #else #define ATTRIBUTES_NOT_SUPPORTED RTEMS_FLOATING_POINT #endif +/** + * This attribute constant indicates the attributes that are + * required given the hardware configuration. + */ #if ( CPU_ALL_TASKS_ARE_FP == TRUE ) #define ATTRIBUTES_REQUIRED RTEMS_FLOATING_POINT #else diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h index 95264aba31..c2a855666d 100644 --- a/cpukit/rtems/include/rtems/rtems/barrier.h +++ b/cpukit/rtems/include/rtems/rtems/barrier.h @@ -13,7 +13,7 @@ * - signal a barrier */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -33,6 +33,12 @@ */ /**@{*/ +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_BARRIER_EXTERN #define RTEMS_BARRIER_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/barriermp.h b/cpukit/rtems/include/rtems/rtems/barriermp.h index c26b65339e..db9622f490 100644 --- a/cpukit/rtems/include/rtems/rtems/barriermp.h +++ b/cpukit/rtems/include/rtems/rtems/barriermp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Barrier Manager. */ -/* COPYRIGHT (c) 1989-2006. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h index c90b240f2b..c73b1496ef 100644 --- a/cpukit/rtems/include/rtems/rtems/cache.h +++ b/cpukit/rtems/include/rtems/rtems/cache.h @@ -4,7 +4,7 @@ * Cache Manager */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/config.h b/cpukit/rtems/include/rtems/rtems/config.h index c12c72b2a1..1c7866ae8d 100644 --- a/cpukit/rtems/include/rtems/rtems/config.h +++ b/cpukit/rtems/include/rtems/rtems/config.h @@ -5,7 +5,7 @@ * parameters specific for the RTEMS API. */ -/* COPYRIGHT (c) 1989-2006. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h index d14cef2c98..5a16107471 100644 --- a/cpukit/rtems/include/rtems/rtems/dpmem.h +++ b/cpukit/rtems/include/rtems/rtems/dpmem.h @@ -16,7 +16,7 @@ * */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -29,6 +29,12 @@ #ifndef _RTEMS_RTEMS_DPMEM_H #define _RTEMS_RTEMS_DPMEM_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_DPMEM_EXTERN #define RTEMS_DPMEM_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h index 584c76eb8c..fcc2b4b4b5 100644 --- a/cpukit/rtems/include/rtems/rtems/event.h +++ b/cpukit/rtems/include/rtems/rtems/event.h @@ -25,6 +25,12 @@ #ifndef _RTEMS_RTEMS_EVENT_H #define _RTEMS_RTEMS_EVENT_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_EVENT_EXTERN #define RTEMS_EVENT_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h index 2ebed71b3f..954d9042f9 100644 --- a/cpukit/rtems/include/rtems/rtems/eventmp.h +++ b/cpukit/rtems/include/rtems/rtems/eventmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Event Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h index 6458cb92c4..c6e991bb96 100644 --- a/cpukit/rtems/include/rtems/rtems/eventset.h +++ b/cpukit/rtems/include/rtems/rtems/eventset.h @@ -6,7 +6,7 @@ * of event sets which will be sent and received by tasks. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -36,10 +36,15 @@ extern "C" { typedef uint32_t rtems_event_set; /** - * The following constants define the individual events which may - * be used to compose an event set. + * The following constant is used to receive the set of currently pending + * events. + */ +#define RTEMS_PENDING_EVENTS 0 + +/** + * The following constant is used when you wish to send or receive all + * events. */ -#define RTEMS_PENDING_EVENTS 0 /* receive pending events */ #define RTEMS_ALL_EVENTS 0xFFFFFFFF /** This defines the bit in the event set associated with event 0. */ diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h index 500040693c..d824960252 100644 --- a/cpukit/rtems/include/rtems/rtems/intr.h +++ b/cpukit/rtems/include/rtems/rtems/intr.h @@ -5,7 +5,7 @@ * with the Interrupt Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 4cd6b7ba94..af81e7ea60 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -17,7 +17,7 @@ * - flush all messages on a queue */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -30,6 +30,12 @@ #ifndef _RTEMS_RTEMS_MESSAGE_H #define _RTEMS_RTEMS_MESSAGE_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_MESSAGE_EXTERN #define RTEMS_MESSAGE_EXTERN extern #endif @@ -52,13 +58,21 @@ extern "C" { */ /**@{*/ -/* +/** * The following enumerated type details the modes in which a message * may be submitted to a message queue. The message may be posted * in a send or urgent fashion. */ typedef enum { + /** + * This value indicates the user wants to send the message using the + * normal message insertion protocol (FIFO or priority). + */ MESSAGE_QUEUE_SEND_REQUEST = 0, + /** + * This value indicates the user considers the message to be urgent + * and wants it inserted at the head of the pending message queue. + */ MESSAGE_QUEUE_URGENT_REQUEST = 1 } Message_queue_Submit_types; @@ -67,12 +81,15 @@ typedef enum { * each message queue. */ typedef struct { + /** This field is the inherited obejct characteristics. */ Objects_Control Object; + /** This field is the attribute set as defined by the API. */ rtems_attribute attribute_set; + /** This field is the instance of the SuperCore Message Queue. */ CORE_message_queue_Control message_queue; } Message_queue_Control; -/* +/** * The following defines the information control block used to * manage this class of objects. */ @@ -292,5 +309,7 @@ void _Message_queue_Core_message_queue_mp_support ( } #endif +/**@}*/ + #endif /* end of include file */ diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h index b2d9ee9fb6..596425643e 100644 --- a/cpukit/rtems/include/rtems/rtems/modes.h +++ b/cpukit/rtems/include/rtems/rtems/modes.h @@ -5,7 +5,7 @@ * with the RTEMS thread and RTEMS_ASR modes. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -43,27 +43,43 @@ typedef uint32_t Modes_Control; */ #define RTEMS_ALL_MODE_MASKS 0x0000ffff +/** + * This mode constant is the default mode set. + */ #define RTEMS_DEFAULT_MODES 0x00000000 + +/** + * This mode constant is used when the user wishes to obtain their + * current execution mode. + */ #define RTEMS_CURRENT_MODE 0 + +/** This mode constant corresponds to the timeslice enable/disable bit. */ +#define RTEMS_TIMESLICE_MASK 0x00000200 -#define RTEMS_PREEMPT_MASK 0x00000100 /* preemption bit */ -#define RTEMS_TIMESLICE_MASK 0x00000200 /* timeslice bit */ -#define RTEMS_ASR_MASK 0x00000400 /* RTEMS_ASR enable bit */ -#define RTEMS_INTERRUPT_MASK CPU_MODES_INTERRUPT_MASK +/** This mode constant corresponds to the preemption enable/disable bit. */ +#define RTEMS_PREEMPT_MASK 0x00000100 -#define RTEMS_PREEMPT 0x00000000 /* enable preemption */ -#define RTEMS_NO_PREEMPT 0x00000100 /* disable preemption */ +/** This mode constant corresponds to the signal enable/disable bit. */ +#define RTEMS_ASR_MASK 0x00000400 -#define RTEMS_NO_TIMESLICE 0x00000000 /* disable timeslicing */ -#define RTEMS_TIMESLICE 0x00000200 /* enable timeslicing */ +/** This mode constant corresponds to the interrupt enable/disable bits. */ +#define RTEMS_INTERRUPT_MASK CPU_MODES_INTERRUPT_MASK -#define RTEMS_ASR 0x00000000 /* enable RTEMS_ASR */ -#define RTEMS_NO_ASR 0x00000400 /* disable RTEMS_ASR */ +/** This mode constant is used to indicate preemption is enabled. */ +#define RTEMS_PREEMPT 0x00000000 +/** This mode constant is used to indicate preemption is disabled. */ +#define RTEMS_NO_PREEMPT 0x00000100 -/** - * The number of bits for interrupt levels is CPU dependent. - * RTEMS supports 0 to 256 levels in bits 0-7 of the mode. - */ +/** This mode constant is used to indicate timeslicing is disabled. */ +#define RTEMS_NO_TIMESLICE 0x00000000 +/** This mode constant is used to indicate timeslicing is enabled. */ +#define RTEMS_TIMESLICE 0x00000200 + +/** This mode constant is used to indicate signal processing is enabled. */ +#define RTEMS_ASR 0x00000000 +/** This mode constant is used to indicate signal processing is disabled. */ +#define RTEMS_NO_ASR 0x00000400 /** * @brief RTEMS_INTERRUPT_LEVEL @@ -87,5 +103,7 @@ typedef uint32_t Modes_Control; } #endif +/**@}*/ + #endif /* end of include file */ diff --git a/cpukit/rtems/include/rtems/rtems/mp.h b/cpukit/rtems/include/rtems/rtems/mp.h index 3e050d73af..8893e1fef0 100644 --- a/cpukit/rtems/include/rtems/rtems/mp.h +++ b/cpukit/rtems/include/rtems/rtems/mp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h index ea9568f639..8668a45c52 100644 --- a/cpukit/rtems/include/rtems/rtems/msgmp.h +++ b/cpukit/rtems/include/rtems/rtems/msgmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Message Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h index a0f5c444d6..240854519c 100644 --- a/cpukit/rtems/include/rtems/rtems/options.h +++ b/cpukit/rtems/include/rtems/rtems/options.h @@ -5,7 +5,7 @@ * options available on many directives. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -41,11 +41,28 @@ typedef uint32_t rtems_option; */ #define RTEMS_DEFAULT_OPTIONS 0x00000000 -#define RTEMS_WAIT 0x00000000 /* wait on resource */ -#define RTEMS_NO_WAIT 0x00000001 /* do not wait on resource */ +/** + * This option constants indicates that the task is to wait on resource. + */ +#define RTEMS_WAIT 0x00000000 +/** + * This option constants indicates that the task is to not wait on + * the resource. If it is not available, return immediately with + * a status to indicate unsatisfied. + */ +#define RTEMS_NO_WAIT 0x00000001 + +/** + * This option constants indicates that the task wishes to wait until + * all events of interest are available. + */ +#define RTEMS_EVENT_ALL 0x00000000 -#define RTEMS_EVENT_ALL 0x00000000 /* wait for all events */ -#define RTEMS_EVENT_ANY 0x00000002 /* wait on any event */ +/** + * This option constants indicates that the task wishes to wait until + * ANY events of interest are available. + */ +#define RTEMS_EVENT_ANY 0x00000002 #ifndef __RTEMS_APPLICATION__ #include @@ -55,5 +72,7 @@ typedef uint32_t rtems_option; } #endif +/**@}*/ + #endif /* end of include file */ diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index fda28714c7..3e1843978a 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -15,7 +15,7 @@ * - return a buffer to a partition */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -28,6 +28,12 @@ #ifndef _RTEMS_RTEMS_PART_H #define _RTEMS_RTEMS_PART_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_PART_EXTERN #define RTEMS_PART_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h index 9401e19b1a..cc92becf07 100644 --- a/cpukit/rtems/include/rtems/rtems/partmp.h +++ b/cpukit/rtems/include/rtems/rtems/partmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Partition Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 622b1c3e1a..56c5f7d6a3 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -14,7 +14,7 @@ * - obtain status information on a period */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -27,6 +27,12 @@ #ifndef _RTEMS_RTEMS_RATEMON_H #define _RTEMS_RTEMS_RATEMON_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_RATEMON_EXTERN #define RTEMS_RATEMON_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index aff2648265..74d66ea334 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -14,7 +14,7 @@ * - return a segment to a region */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -46,6 +46,12 @@ */ /**@{*/ +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_REGION_EXTERN #define RTEMS_REGION_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index 5c4a61cd04..d7736654ff 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Region Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/rtemsapi.h b/cpukit/rtems/include/rtems/rtems/rtemsapi.h index b89f90e96f..5f32085ef6 100644 --- a/cpukit/rtems/include/rtems/rtems/rtemsapi.h +++ b/cpukit/rtems/include/rtems/rtems/rtemsapi.h @@ -4,7 +4,7 @@ * RTEMS API Support */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -20,11 +20,9 @@ #include /** - * @defgroup ClassicRTEMS Classic RTEMS Support - * - * This encapsulates functionality which XXX + * @addtogroup ClassicRTEMS + * @{ */ -/**@{*/ /** * _RTEMS_API_Initialize diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index 9b64e9a810..656717d653 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -15,7 +15,7 @@ * - release a semaphore */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -28,6 +28,12 @@ #ifndef _RTEMS_RTEMS_SEM_H #define _RTEMS_RTEMS_SEM_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_SEM_EXTERN #define RTEMS_SEM_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/semmp.h b/cpukit/rtems/include/rtems/rtems/semmp.h index cabbe1d3ae..248e4f385a 100644 --- a/cpukit/rtems/include/rtems/rtems/semmp.h +++ b/cpukit/rtems/include/rtems/rtems/semmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Semaphore Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -167,5 +167,7 @@ void _Semaphore_Core_semaphore_mp_support ( } #endif +/**@}*/ + #endif /* end of file */ diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h index 5fe1702327..e137feb84d 100644 --- a/cpukit/rtems/include/rtems/rtems/signal.h +++ b/cpukit/rtems/include/rtems/rtems/signal.h @@ -11,7 +11,7 @@ * + send a signal set to a task */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h index bf359473cd..fec8812230 100644 --- a/cpukit/rtems/include/rtems/rtems/signalmp.h +++ b/cpukit/rtems/include/rtems/rtems/signalmp.h @@ -5,7 +5,7 @@ * with the Multiprocessing Support in the Signal Manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h index 644f2cbee6..5a50941136 100644 --- a/cpukit/rtems/include/rtems/rtems/status.h +++ b/cpukit/rtems/include/rtems/rtems/status.h @@ -5,7 +5,7 @@ * executive directives. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h index 2260821788..b204d498a7 100644 --- a/cpukit/rtems/include/rtems/rtems/support.h +++ b/cpukit/rtems/include/rtems/rtems/support.h @@ -25,11 +25,9 @@ extern "C" { #include /** - * @defgroup ClassicSupport Classic API Support - * - * This encapsulates functionality which XXX + * @addtogroup ClassicRTEMS + * @{ */ -/**@{*/ /** * @brief milliseconds to microseconds diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h index 03e1dfbfb8..726772f618 100644 --- a/cpukit/rtems/include/rtems/rtems/taskmp.h +++ b/cpukit/rtems/include/rtems/rtems/taskmp.h @@ -5,7 +5,7 @@ * with the multiprocessing support in the task manager. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index bf30b32d7b..d10ac03853 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -22,7 +22,7 @@ * - wake up when specified */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -44,6 +44,12 @@ #include #include +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_TASKS_EXTERN #define RTEMS_TASKS_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index 980132a448..1fbe458da9 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -22,7 +22,7 @@ * - cancel a time */ -/* COPYRIGHT (c) 1989-2007. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -35,6 +35,12 @@ #ifndef _RTEMS_RTEMS_TIMER_H #define _RTEMS_RTEMS_TIMER_H +/** + * This constant is defined to extern most of the time when using + * this header file. However by defining it to nothing, the data + * declared in this header file can be instantiated. This is done + * in a single per manager file. + */ #ifndef RTEMS_TIMER_EXTERN #define RTEMS_TIMER_EXTERN extern #endif diff --git a/cpukit/rtems/include/rtems/rtems/types.h b/cpukit/rtems/include/rtems/rtems/types.h index 3a04f8e7d8..d8005cf3c2 100644 --- a/cpukit/rtems/include/rtems/rtems/types.h +++ b/cpukit/rtems/include/rtems/rtems/types.h @@ -4,7 +4,7 @@ * This include file defines the types used by the RTEMS API. */ -/* COPYRIGHT (c) 1989-1999. +/* COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be -- cgit v1.2.3