summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2023-05-09 08:08:31 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2023-05-09 08:08:31 +0200
commit2e63b5e261ac8ee62bc75edd1a4e3e0e0a2c6465 (patch)
tree60d90b2d8630d9fea5e3df83ce682a7a16c8d004
parent40a86ba5ead1975f72ae02cea6fd620a95e27cfc (diff)
rtems: Add constraint to types
-rw-r--r--cpukit/include/rtems/rtems/intr.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h
index 6bf6150b93..019bc806b2 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -1041,6 +1041,13 @@ typedef void ( *rtems_interrupt_per_handler_routine )(
* rtems_interrupt_entry_initialize(). It may be installed for an interrupt
* vector with rtems_interrupt_entry_install() and removed from an interrupt
* vector by rtems_interrupt_entry_remove().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct rtems_interrupt_entry {
/**
@@ -2141,6 +2148,13 @@ rtems_status_code rtems_interrupt_handler_iterate(
* view. Members shall not be accessed directly. The structure is initialized
* by rtems_interrupt_server_create() and maintained by the interrupt server
* support.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct rtems_interrupt_server_control {
#if defined(RTEMS_SMP)
@@ -2191,6 +2205,13 @@ typedef struct rtems_interrupt_server_control {
*
* @par Notes
* See also rtems_interrupt_server_create().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct {
/**
@@ -2819,6 +2840,13 @@ rtems_status_code rtems_interrupt_server_handler_iterate(
* @par Notes
* This structure shall be treated as an opaque data type from the API point of
* view. Members shall not be accessed directly.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct rtems_interrupt_server_action {
/**
@@ -2851,6 +2879,13 @@ typedef struct rtems_interrupt_server_action {
* rtems_interrupt_server_entry_destroy(). Interrupt server actions can be
* prepended to the entry by rtems_interrupt_server_action_prepend(). The
* entry is submitted to be serviced by rtems_interrupt_server_entry_submit().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct {
/**
@@ -3165,6 +3200,13 @@ rtems_status_code rtems_interrupt_server_entry_move(
* request can be set by rtems_interrupt_server_request_set_vector(). The
* request is submitted to be serviced by
* rtems_interrupt_server_request_submit().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this structure:
+ *
+ * * Members of the type shall not be accessed directly by the application.
+ * @endparblock
*/
typedef struct {
/**