summaryrefslogtreecommitdiffstats
path: root/cpukit/libcsupport/include/rtems/assoc.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libcsupport/include/rtems/assoc.h')
-rw-r--r--cpukit/libcsupport/include/rtems/assoc.h33
1 files changed, 29 insertions, 4 deletions
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 80a2fe7cdf..70ac56d662 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -32,11 +32,17 @@ typedef struct {
#define RTEMS_ASSOC_DEFAULT_NAME "(default)"
+/**
+ * @brief RTEMS Associate Pointer by Name
+ */
const rtems_assoc_t *rtems_assoc_ptr_by_name(
const rtems_assoc_t *,
const char *
);
+/**
+ * @brief RTEMS Associate Pointer by Remote
+ */
const rtems_assoc_t *rtems_assoc_ptr_by_remote(
const rtems_assoc_t *,
uint32_t
@@ -47,11 +53,17 @@ uint32_t rtems_assoc_remote_by_local(
uint32_t
);
+/**
+ * @brief RTEMS Associate Local by Remote
+ */
uint32_t rtems_assoc_local_by_remote(
const rtems_assoc_t *,
uint32_t
);
+/**
+ * @brief RTEMS Associate Remote by Name
+ */
uint32_t rtems_assoc_remote_by_name(
const rtems_assoc_t *,
const char *
@@ -65,6 +77,9 @@ uint32_t rtems_assoc_local_by_name(
const char *
);
+/**
+ * @brief RTEMS Associate Name by Local
+ */
const char *rtems_assoc_name_by_local(
const rtems_assoc_t *,
uint32_t
@@ -83,12 +98,18 @@ uint32_t rtems_assoc_remote_by_local_bitfield(
uint32_t
);
+/**
+ * @brief RTEMS Associate Name by Local Bitfield
+ */
char *rtems_assoc_name_by_local_bitfield(
const rtems_assoc_t *,
uint32_t ,
char *
);
+/**
+ * @brief RTEMS Associate Name by Remote Bitfield
+ */
char *rtems_assoc_name_by_remote_bitfield(
const rtems_assoc_t *,
uint32_t ,
@@ -100,6 +121,9 @@ uint32_t rtems_assoc_local_by_remote_bitfield(
uint32_t
);
+/**
+ * @brief RTEMS Associate Pointer by Local
+ */
const rtems_assoc_t *rtems_assoc_ptr_by_local(
const rtems_assoc_t *ap,
uint32_t local_value
@@ -110,11 +134,12 @@ const rtems_assoc_t *rtems_assoc_ptr_by_local(
#define rtems_assoc_is_default(_ap) \
((_ap)->name && !strcmp((_ap)->name, RTEMS_ASSOC_DEFAULT_NAME))
-/*
- * what to return if a value is not found
- * this is not reentrant, but it really shouldn't be invoked anyway
+/**
+ * @brief RTEMS Associate Bad Name
+ *
+ * what to return if a value is not found
+ * this is not reentrant, but it really shouldn't be invoked anyway
*/
-
const char *rtems_assoc_name_bad(
uint32_t bad_value
);