From c85ab23ab7169b2c7a30f3d747b5f6339bc4a6e9 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 5 Aug 2009 18:17:12 +0000 Subject: 2009-08-05 Sebastian Huber * libcsupport/include/rtems/libio_.h, libcsupport/src/fs_null_handlers.c: Null handlers are now const. * libi2c/libi2c.c, libi2c/libi2c.h: Documentation. Do not create semaphores on the fly. * cpukit/libblock/src/bdpart.c: Fixed format specifier. * cpukit/libblock/include/rtems/bdbuf.h, rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/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/support.inl: Documentation. * include/rtems/irq-extension.h: Documentation. Added API for interrupt servers. --- cpukit/rtems/include/rtems.h | 95 +++++++++++++--------------- cpukit/rtems/include/rtems/rtems/asr.h | 4 +- cpukit/rtems/include/rtems/rtems/attr.h | 4 +- cpukit/rtems/include/rtems/rtems/barrier.h | 4 +- cpukit/rtems/include/rtems/rtems/barriermp.h | 4 +- cpukit/rtems/include/rtems/rtems/cache.h | 4 +- cpukit/rtems/include/rtems/rtems/clock.h | 4 +- cpukit/rtems/include/rtems/rtems/config.h | 4 +- cpukit/rtems/include/rtems/rtems/dpmem.h | 4 +- cpukit/rtems/include/rtems/rtems/event.h | 4 +- cpukit/rtems/include/rtems/rtems/eventmp.h | 4 +- cpukit/rtems/include/rtems/rtems/eventset.h | 4 +- cpukit/rtems/include/rtems/rtems/intr.h | 4 +- cpukit/rtems/include/rtems/rtems/message.h | 4 +- cpukit/rtems/include/rtems/rtems/modes.h | 4 +- cpukit/rtems/include/rtems/rtems/mp.h | 4 +- cpukit/rtems/include/rtems/rtems/msgmp.h | 4 +- cpukit/rtems/include/rtems/rtems/object.h | 4 +- cpukit/rtems/include/rtems/rtems/part.h | 4 +- cpukit/rtems/include/rtems/rtems/partmp.h | 4 +- cpukit/rtems/include/rtems/rtems/ratemon.h | 4 +- cpukit/rtems/include/rtems/rtems/region.h | 4 +- cpukit/rtems/include/rtems/rtems/regionmp.h | 4 +- cpukit/rtems/include/rtems/rtems/rtemsapi.h | 5 -- cpukit/rtems/include/rtems/rtems/sem.h | 4 +- cpukit/rtems/include/rtems/rtems/semmp.h | 4 +- cpukit/rtems/include/rtems/rtems/signal.h | 4 +- cpukit/rtems/include/rtems/rtems/signalmp.h | 4 +- cpukit/rtems/include/rtems/rtems/status.h | 4 +- cpukit/rtems/include/rtems/rtems/support.h | 72 +++++++++++---------- cpukit/rtems/include/rtems/rtems/taskmp.h | 4 +- cpukit/rtems/include/rtems/rtems/tasks.h | 4 +- cpukit/rtems/include/rtems/rtems/timer.h | 4 +- cpukit/rtems/include/rtems/rtems/types.h | 4 +- 34 files changed, 177 insertions(+), 119 deletions(-) (limited to 'cpukit/rtems/include') diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h index 4bc89d704e..ec7db33254 100644 --- a/cpukit/rtems/include/rtems.h +++ b/cpukit/rtems/include/rtems.h @@ -1,8 +1,9 @@ /** - * @file rtems.h + * @file * - * This include file provides the public interface to the RTEMS Classic - * API. + * @ingroup ClassicRTEMS + * + * @brief Provides the public interface to the RTEMS Classic API. */ /* COPYRIGHT (c) 1989-2008. @@ -19,12 +20,12 @@ #define _RTEMS_H /** - * @defgroup ClassicRTEMS Classic API RTEMS Header + * @defgroup ClassicRTEMS RTEMS Classic API + * + * RTEMS Classic API definitions and modules. * - * This encapsulates functionality which is specific to the Classic API - * and generally shared across the various object classes. + * @{ */ -/**@{*/ #ifdef __cplusplus extern "C" { @@ -33,13 +34,13 @@ extern "C" { #if (!defined(__RTEMS_VIOLATE_KERNEL_VISIBILITY__)) && \ (!defined(__RTEMS_INSIDE__)) /** - * @brief Compiling RTEMS Application Macro + * @brief Compiling RTEMS application macro. * - * Unless told otherwise, the RTEMS include files will hide some stuff - * from normal application code. Defining this crosses a boundary which - * is undesirable since it means your application is using RTEMS features - * which are not included in the formally defined and supported API. - * Define this at your own risk. + * Unless told otherwise, the RTEMS include files will hide some stuff from + * normal application code. Defining this crosses a boundary which is + * undesirable since it means your application is using RTEMS features which + * are not included in the formally defined and supported API. Define this at + * your own risk. */ #define __RTEMS_APPLICATION__ #endif @@ -78,17 +79,13 @@ extern "C" { #include /** - * @brief Obtain the RTEMS Version String - * - * This method may be used to obtain the RTEMS version string. - * - * @return This method returns a pointer to the version string. + * @brief Returns the pointer to the RTEMS version string. */ const char *rtems_get_version_string(void); /** - * This constant indicates whether this processor variant has - * hardware floating point support. + * @brief Indicates whether this processor variant has hardware floating point + * support. */ #define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP @@ -97,28 +94,26 @@ const char *rtems_get_version_string(void); **********************************************************************/ /** - * This constant indicates that the search is across all nodes. + * @brief Indicates that a search is across all nodes. */ #define RTEMS_SEARCH_ALL_NODES OBJECTS_SEARCH_ALL_NODES /** - * This constant indicates that the search is across all nodes - * except the one the call is made from. + * @brief Indicates that a search is across all nodes except the one the call + * is made from. */ #define RTEMS_SEARCH_OTHER_NODES OBJECTS_SEARCH_OTHER_NODES /** - * This constant indicates that the search is to be restricted - * to the local node. + * @brief Indicates that the search is to be restricted to the local node. */ #define RTEMS_SEARCH_LOCAL_NODE OBJECTS_SEARCH_LOCAL_NODE /** - * This constant indicates that the caller wants to obtain the - * name of the currently executing thread. + * @brief Indicates that the caller wants to obtain the name of the currently + * executing thread. * - * @note This constant is only meaningful when obtaining the name - * of a task. + * This constant is only meaningful when obtaining the name of a task. */ #define RTEMS_WHO_AM_I OBJECTS_WHO_AM_I @@ -127,61 +122,61 @@ const char *rtems_get_version_string(void); **********************************************************************/ /** - * This constant is the lowest valid valid for the index portion - * of an object Id. + * @brief Lowest valid index value for the index portion of an object + * identifier. */ #define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX /** - * This constant is the maximum valid valid for the index portion - * of an object Id. + * @brief Maximum valid index value for the index portion of an object + * identifier. */ #define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX /** - * This method returns the Id of the object with the lowest - * valid index valud. + * @brief Returns the identifier of the object with the lowest valid index + * value. * - * @param[in] _api is the API of the object - * @param[in] _class is the Object Class of the object - * @param[in] _node is the node where the object resides + * The object is specified by the API @a _api, the object class @a _class and + * the node @a _node where the object resides. */ #define RTEMS_OBJECT_ID_INITIAL(_api, _class, _node) \ OBJECTS_ID_INITIAL(_api, _class, _node) /** - * This constant is the maximum valid object Id. + * @brief Maximum valid object identifier. */ #define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL /** - * The following constant defines the minimum stack size which every - * thread must exceed. + * @brief Minimum stack size which every thread must exceed. */ #define RTEMS_MINIMUM_STACK_SIZE STACK_MINIMUM_SIZE /** - * The following constant is used to specify that the task should - * be created with the configured minimum stack size. + * @brief Specifies that the task should be created with the configured minimum + * stack size. */ #define RTEMS_CONFIGURED_MINIMUM_STACK_SIZE 0 /** - * Constant for indefinite wait. (actually an illegal interval) + * @brief Constant for indefinite wait. + * + * This is actually an illegal interval value. */ #define RTEMS_NO_TIMEOUT WATCHDOG_NO_TIMEOUT /** - * An MPCI must support packets of at least this size. + * @brief An MPCI must support packets of at least this size. */ #define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE /** - * The following constant defines the number of uint32_t's - * in a packet which must be converted to native format in a - * heterogeneous system. In packets longer than - * MP_PACKET_MINIMUN_HETERO_CONVERSION uint32_t's, some of the "extra" data - * may a user message buffer which is not automatically endian swapped. + * @brief Defines the count of @c uint32_t numbers in a packet which must be + * converted to native format in a heterogeneous system. + * + * In packets longer than this value, some of the extra data may be a user + * message buffer which is not automatically endian swapped. */ #define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h index ea5fab8538..d733bd0626 100644 --- a/cpukit/rtems/include/rtems/rtems/asr.h +++ b/cpukit/rtems/include/rtems/rtems/asr.h @@ -26,7 +26,9 @@ extern "C" { #endif /** - * @defgroup ClassicASR Classic API ASR Support + * @defgroup ClassicASR ASR Support + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h index 693cfdbaa9..5b3480f967 100644 --- a/cpukit/rtems/include/rtems/rtems/attr.h +++ b/cpukit/rtems/include/rtems/rtems/attr.h @@ -23,7 +23,9 @@ extern "C" { #endif /** - * @defgroup ClassicAttributes Classic API Attributes + * @defgroup ClassicAttributes Attributes + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which defines and manages the * set of Classic API object attributes. diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h index 19e32e4a78..d598bd101b 100644 --- a/cpukit/rtems/include/rtems/rtems/barrier.h +++ b/cpukit/rtems/include/rtems/rtems/barrier.h @@ -27,7 +27,9 @@ #define _RTEMS_RTEMS_BARRIER_H /** - * @defgroup ClassicBarrier Classic API Barrier + * @defgroup ClassicBarrier Barriers + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/barriermp.h b/cpukit/rtems/include/rtems/rtems/barriermp.h index db9622f490..1a20680665 100644 --- a/cpukit/rtems/include/rtems/rtems/barriermp.h +++ b/cpukit/rtems/include/rtems/rtems/barriermp.h @@ -19,7 +19,9 @@ #define _RTEMS_RTEMS_SEMMP_H /** - * @defgroup ClassicBarrierMP Classic API Barrier MP Support + * @defgroup ClassicBarrierMP Barrier MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h index c73b1496ef..72aab56cea 100644 --- a/cpukit/rtems/include/rtems/rtems/cache.h +++ b/cpukit/rtems/include/rtems/rtems/cache.h @@ -38,7 +38,9 @@ extern "C" { #include /** - * @defgroup ClassicCache Classic API Cache + * @defgroup ClassicCache Cache + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h index e638acc030..124d04e8d8 100644 --- a/cpukit/rtems/include/rtems/rtems/clock.h +++ b/cpukit/rtems/include/rtems/rtems/clock.h @@ -35,7 +35,9 @@ #include /* struct timeval */ /** - * @defgroup ClassicClock Classic API Clock + * @defgroup ClassicClock Clocks + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/config.h b/cpukit/rtems/include/rtems/rtems/config.h index dc69af0067..4b6ea93bc2 100644 --- a/cpukit/rtems/include/rtems/rtems/config.h +++ b/cpukit/rtems/include/rtems/rtems/config.h @@ -26,7 +26,9 @@ extern "C" { #endif /** - * @defgroup ClassicConfig Classic API Configuration + * @defgroup ClassicConfig Configuration + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h index 3c4dce1499..a511024856 100644 --- a/cpukit/rtems/include/rtems/rtems/dpmem.h +++ b/cpukit/rtems/include/rtems/rtems/dpmem.h @@ -48,7 +48,9 @@ extern "C" { #include /** - * @defgroup ClassicDPMEM Classic API Dual Ported Memory + * @defgroup ClassicDPMEM Dual Ported Memory + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to the * Classic API Dual Ported Memory Manager. diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h index fcc2b4b4b5..2ac4692171 100644 --- a/cpukit/rtems/include/rtems/rtems/event.h +++ b/cpukit/rtems/include/rtems/rtems/event.h @@ -49,7 +49,9 @@ extern "C" { #include /** - * @defgroup ClassicEvent Classic API Event + * @defgroup ClassicEvent Events + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h index 954d9042f9..bc44fe6aab 100644 --- a/cpukit/rtems/include/rtems/rtems/eventmp.h +++ b/cpukit/rtems/include/rtems/rtems/eventmp.h @@ -29,7 +29,9 @@ extern "C" { #include /** - * @defgroup ClassicEventMP Classic API Event MP Support + * @defgroup ClassicEventMP Event MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h index e8e50bd06f..679934f22b 100644 --- a/cpukit/rtems/include/rtems/rtems/eventset.h +++ b/cpukit/rtems/include/rtems/rtems/eventset.h @@ -20,7 +20,9 @@ #define _RTEMS_RTEMS_EVENTSET_H /** - * @defgroup ClassicEventSet Classic API Event Set + * @defgroup ClassicEventSet Event Sets + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to Classic API * Event Sets. These are used by the Classic API Event Manager. diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h index 747c14420f..1576416879 100644 --- a/cpukit/rtems/include/rtems/rtems/intr.h +++ b/cpukit/rtems/include/rtems/rtems/intr.h @@ -27,7 +27,9 @@ extern "C" { #include /** - * @defgroup ClassicINTR Classic API Interrupt + * @defgroup ClassicINTR Interrupts + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index aab42b6b1f..772f9d3654 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -53,7 +53,9 @@ extern "C" { #include /** - * @defgroup ClassicMessageQueue Classic API Message Queue + * @defgroup ClassicMessageQueue Message Queues + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h index 596425643e..b531a27b5d 100644 --- a/cpukit/rtems/include/rtems/rtems/modes.h +++ b/cpukit/rtems/include/rtems/rtems/modes.h @@ -19,7 +19,9 @@ #define _RTEMS_RTEMS_MODES_H /** - * @defgroup ClassicModes Classic API Modes + * @defgroup ClassicModes Modes + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/mp.h b/cpukit/rtems/include/rtems/rtems/mp.h index 8893e1fef0..1f8252aac3 100644 --- a/cpukit/rtems/include/rtems/rtems/mp.h +++ b/cpukit/rtems/include/rtems/rtems/mp.h @@ -19,7 +19,9 @@ #define _RTEMS_RTEMS_MP_H /** - * @defgroup ClassicMP Classic API Multiprocessing + * @defgroup ClassicMP Multiprocessing + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h index 3b7d82357a..8aa5f533ae 100644 --- a/cpukit/rtems/include/rtems/rtems/msgmp.h +++ b/cpukit/rtems/include/rtems/rtems/msgmp.h @@ -30,7 +30,9 @@ extern "C" { #include /** - * @defgroup ClassicMsgMP Classic API Message Queue MP Support + * @defgroup ClassicMsgMP Message Queue MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h index 58ca9f8b6c..d419a3b095 100644 --- a/cpukit/rtems/include/rtems/rtems/object.h +++ b/cpukit/rtems/include/rtems/rtems/object.h @@ -25,7 +25,9 @@ extern "C" { #endif /** - * @defgroup ClassicClassInfo Classic API Class Information + * @defgroup ClassicClassInfo Object Class Information + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index 84245aa78b..8a41ad2ee6 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -50,7 +50,9 @@ extern "C" { #include /** - * @defgroup ClassicPart Classic API Partition + * @defgroup ClassicPart Partitions + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to the * Classic API Partition Manager. diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h index 69a6646746..f36f0e259c 100644 --- a/cpukit/rtems/include/rtems/rtems/partmp.h +++ b/cpukit/rtems/include/rtems/rtems/partmp.h @@ -30,7 +30,9 @@ extern "C" { #include /** - * @defgroup ClassicPartMP Classic API Partition MP Support + * @defgroup ClassicPartMP Partition MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 2959acea72..925efda1a9 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -40,7 +40,9 @@ #include /** - * @defgroup ClassicRateMon Classic API Rate Monotonic + * @defgroup ClassicRateMon Rate Monotonic Scheduler + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to the * Classic API Rate Monotonic Manager. diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index a86aae57cb..938be4e77d 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -38,7 +38,9 @@ #include /** - * @defgroup ClassicRegion Classic API Region + * @defgroup ClassicRegion Regions + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index ba6816bb3d..b748aba8e8 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -30,7 +30,9 @@ extern "C" { #include /** - * @defgroup ClassicRegionMP Classic API Region MP Support + * @defgroup ClassicRegionMP Region MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/rtemsapi.h b/cpukit/rtems/include/rtems/rtems/rtemsapi.h index da703813e3..d75dbb0490 100644 --- a/cpukit/rtems/include/rtems/rtems/rtemsapi.h +++ b/cpukit/rtems/include/rtems/rtems/rtemsapi.h @@ -19,11 +19,6 @@ #include -/** - * @addtogroup ClassicRTEMS - * @{ - */ - /** * _RTEMS_API_Initialize * diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index e7ded959c6..406e1541f5 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -52,7 +52,9 @@ extern "C" { #include /** - * @defgroup ClassicSem Classic API Semaphore + * @defgroup ClassicSem Semaphores + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to the Classic API * Semaphore Manager. diff --git a/cpukit/rtems/include/rtems/rtems/semmp.h b/cpukit/rtems/include/rtems/rtems/semmp.h index 248e4f385a..1be30ef467 100644 --- a/cpukit/rtems/include/rtems/rtems/semmp.h +++ b/cpukit/rtems/include/rtems/rtems/semmp.h @@ -30,7 +30,9 @@ extern "C" { #include /** - * @defgroup ClassicSEM Classic API Semaphore MP Support + * @defgroup ClassicSEM Semaphore MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h index e137feb84d..5f3be2a606 100644 --- a/cpukit/rtems/include/rtems/rtems/signal.h +++ b/cpukit/rtems/include/rtems/rtems/signal.h @@ -25,7 +25,9 @@ #define _RTEMS_RTEMS_SIGNAL_H /** - * @defgroup ClassicSignal Classic API Signal + * @defgroup ClassicSignal Signals + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h index fec8812230..49fc37b0d0 100644 --- a/cpukit/rtems/include/rtems/rtems/signalmp.h +++ b/cpukit/rtems/include/rtems/rtems/signalmp.h @@ -29,7 +29,9 @@ extern "C" { #include /** - * @defgroup ClassicSignalMP Classic API Signal MP Support + * @defgroup ClassicSignalMP Signal MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h index 1c5b4d05f7..0f42a8b54d 100644 --- a/cpukit/rtems/include/rtems/rtems/status.h +++ b/cpukit/rtems/include/rtems/rtems/status.h @@ -19,7 +19,9 @@ #define _RTEMS_RTEMS_STATUS_H /** - * @defgroup ClassicStatus Classic API Status + * @defgroup ClassicStatus Status Codes + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h index 8d8a85a825..220411d984 100644 --- a/cpukit/rtems/include/rtems/rtems/support.h +++ b/cpukit/rtems/include/rtems/rtems/support.h @@ -1,8 +1,11 @@ /** - * @file rtems/rtems/support.h + * @file * - * This include file contains information about support functions for - * the RTEMS API. + * @ingroup ClassicRTEMS + * + * @ingroup ClassicRTEMSWorkspace + * + * @brief Classic API support. */ /* COPYRIGHT (c) 1989-2008. @@ -25,58 +28,61 @@ extern "C" { #include /** - * @addtogroup ClassicRTEMS - * @{ + * @addtogroup ClassicRTEMS + * + * @{ */ /** - * @brief milliseconds to microseconds - * - * This is the public milliseconds to microseconds conversion. + * @brief Returns the number of micro seconds for the milli seconds value @a _ms. */ #define RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) \ TOD_MILLISECONDS_TO_MICROSECONDS(_ms) /** - * @brief milliseconds to ticks - * - * This is the public milliseconds to ticks conversion. + * @brief Returns the number of ticks for the milli seconds value @a _ms. */ #define RTEMS_MILLISECONDS_TO_TICKS(_ms) \ (TOD_MILLISECONDS_TO_MICROSECONDS(_ms) / \ rtems_configuration_get_microseconds_per_tick()) /** - * @brief microseconds to ticks - * - * This is the public microseconds to tick conversion. + * @brief Returns the number of ticks for the micro seconds value @a _us. */ -#define RTEMS_MICROSECONDS_TO_TICKS(_ms) \ - ((_ms) / rtems_configuration_get_microseconds_per_tick()) +#define RTEMS_MICROSECONDS_TO_TICKS(_us) \ + ((_us) / rtems_configuration_get_microseconds_per_tick()) + +/** @} */ /** - * @brief get workspace information + * @defgroup ClassicRTEMSWorkspace Workspace * - * This returns information about the heap that is used as - * the RTEMS Executive Workspace. + * @ingroup ClassicRTEMS * - * @param[in] the_info + * Workspace definitions. * - * @return true if successful + * @{ + */ + +/** + * @brief Gets workspace information. + * + * Returns information about the heap that is used as the RTEMS Executive + * Workspace in @a the_info. + * + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_get_information( Heap_Information_block *the_info ); /** - * @brief allocate memory from workspace + * @brief Allocates memory from the workspace. * - * This allocates memory from the the RTEMS Executive Workspace. + * A number of @a bytes bytes will be allocated from the RTEMS Executive + * Workspace and returned in @a pointer. * - * @param[in] bytes is the number of bytes to allocate - * @param[in] pointer is the returned pointer to allocated memory - * - * @return true if successful + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_allocate( size_t bytes, @@ -84,19 +90,19 @@ bool rtems_workspace_allocate( ); /** - * @brief free memory back to the workspace - * - * This frees memory that was allocated from - * the RTEMS Executive Workspace. + * @brief Frees memory allocated from the workspace. * - * @param[in] pointer is the allocated workspace + * This frees the memory indicated by @a pointer that was allocated from the + * RTEMS Executive Workspace. * - * @return true if successful + * Returns @c true if successful, and @a false otherwise. */ bool rtems_workspace_free( void *pointer ); +/** @} */ + #ifndef __RTEMS_APPLICATION__ #include #endif diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h index 726772f618..16bf205d8d 100644 --- a/cpukit/rtems/include/rtems/rtems/taskmp.h +++ b/cpukit/rtems/include/rtems/rtems/taskmp.h @@ -26,7 +26,9 @@ #include /** - * @defgroup ClassicTaskMP Classic API Task MP Support + * @defgroup ClassicTaskMP Task MP Support + * + * @ingroup ClassicMP * * This encapsulates functionality which XXX */ diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index 5aa1475f70..049e709fd6 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -55,7 +55,9 @@ #endif /** - * @defgroup ClassicTasks Classic API Tasks + * @defgroup ClassicTasks Tasks + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which X XX */ diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index f3d375818f..deac24324a 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -56,7 +56,9 @@ extern "C" { #include /** - * @defgroup ClassicTimer Classic API Timer + * @defgroup ClassicTimer Timers + * + * @ingroup ClassicRTEMS * * This encapsulates functionality related to the Classic API Timer * Manager. This manager provides functionality which allows the diff --git a/cpukit/rtems/include/rtems/rtems/types.h b/cpukit/rtems/include/rtems/rtems/types.h index 0fbf7003ca..4cd4dd5a0d 100644 --- a/cpukit/rtems/include/rtems/rtems/types.h +++ b/cpukit/rtems/include/rtems/rtems/types.h @@ -18,7 +18,9 @@ #define _RTEMS_RTEMS_TYPES_H /** - * @defgroup ClassicTypes Classic API Types + * @defgroup ClassicTypes Types + * + * @ingroup ClassicRTEMS * * This encapsulates functionality which XXX */ -- cgit v1.2.3