[PATCH] rtems: Add constraint to types

Sebastian Huber sebastian.huber at embedded-brains.de
Tue May 9 06:08:58 UTC 2023


---
 cpukit/include/rtems/rtems/intr.h | 42 +++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

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 {
   /**
-- 
2.35.3



More information about the devel mailing list