summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/eventset.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/eventset.h60
1 files changed, 48 insertions, 12 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h
index 77fbabf763..6458cb92c4 100644
--- a/cpukit/rtems/include/rtems/rtems/eventset.h
+++ b/cpukit/rtems/include/rtems/rtems/eventset.h
@@ -1,13 +1,12 @@
/**
* @file rtems/rtems/eventset.h
- */
-
-/*
+ *
* This include file contains the information pertaining to the
* Event Sets Handler. This handler provides methods for the manipulation
* of event sets which will be sent and received by tasks.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -20,63 +19,98 @@
#ifndef _RTEMS_RTEMS_EVENTSET_H
#define _RTEMS_RTEMS_EVENTSET_H
+/**
+ * @defgroup ClassicEventSet Classic API Event Set
+ *
+ * This encapsulates functionality which XXX
+ */
+/**@{*/
+
#ifdef __cplusplus
extern "C" {
#endif
-/*
+/**
* The following defines the type used to control event sets.
*/
-
typedef uint32_t rtems_event_set;
-/*
+/**
* The following constants define the individual events which may
* be used to compose an event set.
*/
-
#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. */
#define RTEMS_EVENT_0 0x00000001
+/** This defines the bit in the event set associated with event 1. */
#define RTEMS_EVENT_1 0x00000002
+/** This defines the bit in the event set associated with event 2. */
#define RTEMS_EVENT_2 0x00000004
+/** This defines the bit in the event set associated with event 3. */
#define RTEMS_EVENT_3 0x00000008
+/** This defines the bit in the event set associated with event 4. */
#define RTEMS_EVENT_4 0x00000010
+/** This defines the bit in the event set associated with event 5. */
#define RTEMS_EVENT_5 0x00000020
+/** This defines the bit in the event set associated with event 6. */
#define RTEMS_EVENT_6 0x00000040
+/** This defines the bit in the event set associated with event 7. */
#define RTEMS_EVENT_7 0x00000080
+/** This defines the bit in the event set associated with event 8. */
#define RTEMS_EVENT_8 0x00000100
+/** This defines the bit in the event set associated with event 9. */
#define RTEMS_EVENT_9 0x00000200
+/** This defines the bit in the event set associated with event 10. */
#define RTEMS_EVENT_10 0x00000400
+/** This defines the bit in the event set associated with event 11. */
#define RTEMS_EVENT_11 0x00000800
+/** This defines the bit in the event set associated with event 12. */
#define RTEMS_EVENT_12 0x00001000
+/** This defines the bit in the event set associated with event 13. */
#define RTEMS_EVENT_13 0x00002000
+/** This defines the bit in the event set associated with event 14. */
#define RTEMS_EVENT_14 0x00004000
+/** This defines the bit in the event set associated with event 15. */
#define RTEMS_EVENT_15 0x00008000
+/** This defines the bit in the event set associated with event 16. */
#define RTEMS_EVENT_16 0x00010000
+/** This defines the bit in the event set associated with event 17. */
#define RTEMS_EVENT_17 0x00020000
+/** This defines the bit in the event set associated with event 18. */
#define RTEMS_EVENT_18 0x00040000
+/** This defines the bit in the event set associated with event 19. */
#define RTEMS_EVENT_19 0x00080000
+/** This defines the bit in the event set associated with event 20. */
#define RTEMS_EVENT_20 0x00100000
+/** This defines the bit in the event set associated with event 21. */
#define RTEMS_EVENT_21 0x00200000
+/** This defines the bit in the event set associated with event 22. */
#define RTEMS_EVENT_22 0x00400000
+/** This defines the bit in the event set associated with event 23. */
#define RTEMS_EVENT_23 0x00800000
+/** This defines the bit in the event set associated with event 24. */
#define RTEMS_EVENT_24 0x01000000
+/** This defines the bit in the event set associated with event 25. */
#define RTEMS_EVENT_25 0x02000000
+/** This defines the bit in the event set associated with event 26. */
#define RTEMS_EVENT_26 0x04000000
+/** This defines the bit in the event set associated with event 27. */
#define RTEMS_EVENT_27 0x08000000
+/** This defines the bit in the event set associated with event 29. */
#define RTEMS_EVENT_28 0x10000000
+/** This defines the bit in the event set associated with event 29. */
#define RTEMS_EVENT_29 0x20000000
+/** This defines the bit in the event set associated with event 30. */
#define RTEMS_EVENT_30 0x40000000
+/** This defines the bit in the event set associated with event 31. */
#define RTEMS_EVENT_31 0x80000000
-
-/*
+/**
* The following constant is the value of an event set which
* has no events pending.
*/
-
#define EVENT_SETS_NONE_PENDING 0
#ifndef __RTEMS_APPLICATION__
@@ -87,5 +121,7 @@ typedef uint32_t rtems_event_set;
}
#endif
+/**@}*/
+
#endif
/* end of include file */