testsuites/validation/tr-event-send-receive.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RtemsEventReqSendReceive
0007  */
0008
0009 /*
0010  * Copyright (C) 2020 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 /*
0035  * This file is part of the RTEMS quality process and was automatically
0036  * generated.  If you find something that needs to be fixed or
0037  * worded better please post a report or patch to an RTEMS mailing list
0038  * or raise a bug report:
0039  *
0040  * https://www.rtems.org/bugs.html
0041  *
0042  * For information on updating and regenerating please refer to the How-To
0043  * section in the Software Requirements Engineering chapter of the
0044  * RTEMS Software Engineering manual.  The manual is provided as a part of
0045  * a release.  For development sources please refer to the online
0046  * documentation at:
0047  *
0048  * https://docs.rtems.org
0049  */
0050
0051 #ifndef _TR_EVENT_SEND_RECEIVE_H
0052 #define _TR_EVENT_SEND_RECEIVE_H
0053
0054 #include <rtems.h>
0055 #include <rtems/score/thread.h>
0056
0057 #ifdef __cplusplus
0058 extern "C" {
0059 #endif
0060
0061 /**
0062  * @addtogroup RtemsEventReqSendReceive
0063  *
0064  * @{
0065  */
0066
0067 typedef enum {
0068   RtemsEventReqSendReceive_Pre_Id_InvId,
0069   RtemsEventReqSendReceive_Pre_Id_Task,
0070   RtemsEventReqSendReceive_Pre_Id_NA
0071 } RtemsEventReqSendReceive_Pre_Id;
0072
0073 typedef enum {
0074   RtemsEventReqSendReceive_Pre_Send_Zero,
0075   RtemsEventReqSendReceive_Pre_Send_Unrelated,
0076   RtemsEventReqSendReceive_Pre_Send_Any,
0077   RtemsEventReqSendReceive_Pre_Send_All,
0078   RtemsEventReqSendReceive_Pre_Send_MixedAny,
0079   RtemsEventReqSendReceive_Pre_Send_MixedAll,
0080   RtemsEventReqSendReceive_Pre_Send_NA
0081 } RtemsEventReqSendReceive_Pre_Send;
0082
0083 typedef enum {
0084   RtemsEventReqSendReceive_Pre_ReceiverState_InvAddr,
0085   RtemsEventReqSendReceive_Pre_ReceiverState_NotWaiting,
0086   RtemsEventReqSendReceive_Pre_ReceiverState_Poll,
0087   RtemsEventReqSendReceive_Pre_ReceiverState_Timeout,
0088   RtemsEventReqSendReceive_Pre_ReceiverState_Lower,
0089   RtemsEventReqSendReceive_Pre_ReceiverState_Equal,
0090   RtemsEventReqSendReceive_Pre_ReceiverState_Higher,
0091   RtemsEventReqSendReceive_Pre_ReceiverState_Other,
0092   RtemsEventReqSendReceive_Pre_ReceiverState_Intend,
0093   RtemsEventReqSendReceive_Pre_ReceiverState_NA
0094 } RtemsEventReqSendReceive_Pre_ReceiverState;
0095
0096 typedef enum {
0097   RtemsEventReqSendReceive_Pre_Satisfy_All,
0098   RtemsEventReqSendReceive_Pre_Satisfy_Any,
0099   RtemsEventReqSendReceive_Pre_Satisfy_NA
0100 } RtemsEventReqSendReceive_Pre_Satisfy;
0101
0102 typedef enum {
0103   RtemsEventReqSendReceive_Post_SendStatus_Ok,
0104   RtemsEventReqSendReceive_Post_SendStatus_InvId,
0105   RtemsEventReqSendReceive_Post_SendStatus_NA
0106 } RtemsEventReqSendReceive_Post_SendStatus;
0107
0108 typedef enum {
0109   RtemsEventReqSendReceive_Post_ReceiveStatus_None,
0110   RtemsEventReqSendReceive_Post_ReceiveStatus_Pending,
0111   RtemsEventReqSendReceive_Post_ReceiveStatus_Timeout,
0112   RtemsEventReqSendReceive_Post_ReceiveStatus_Satisfied,
0113   RtemsEventReqSendReceive_Post_ReceiveStatus_Unsatisfied,
0114   RtemsEventReqSendReceive_Post_ReceiveStatus_Blocked,
0115   RtemsEventReqSendReceive_Post_ReceiveStatus_InvAddr,
0116   RtemsEventReqSendReceive_Post_ReceiveStatus_NA
0117 } RtemsEventReqSendReceive_Post_ReceiveStatus;
0118
0119 typedef enum {
0120   RtemsEventReqSendReceive_Post_SenderPreemption_No,
0121   RtemsEventReqSendReceive_Post_SenderPreemption_Yes,
0122   RtemsEventReqSendReceive_Post_SenderPreemption_NA
0123 } RtemsEventReqSendReceive_Post_SenderPreemption;
0124
0125 /**
0126  * @brief Runs the parameterized test case.
0127  *
0128  * @param send is the event send handler.
0129  *
0130  * @param receive is the event receive handler.
0131  *
0132  * @param get_pending_events is the get pending events handler.
0133  *
0134  * @param wait_class is the thread wait class.
0135  *
0136  * @param waiting_for_event is the thread waiting for event state.
0137  */
0138 void RtemsEventReqSendReceive_Run(
0139   rtems_status_code ( *send )( rtems_id, rtems_event_set ),
0140   rtems_status_code ( *receive )( rtems_event_set, rtems_option, rtems_interval, rtems_event_set * ),
0141   rtems_event_set (   *get_pending_events )( Thread_Control * ),
0142   unsigned int         wait_class,
0143   int                  waiting_for_event
0144 );
0145
0146 /** @} */
0147
0148 #ifdef __cplusplus
0149 }
0150 #endif
0151
0152 #endif /* _TR_EVENT_SEND_RECEIVE_H */