testsuites/validation/tr-mtx-surrender.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup ScoreMtxReqSurrender
0007  */
0008
0009 /*
0010  * Copyright (C) 2021 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_MTX_SURRENDER_H
0052 #define _TR_MTX_SURRENDER_H
0053
0054 #include "tx-thread-queue.h"
0055
0056 #ifdef __cplusplus
0057 extern "C" {
0058 #endif
0059
0060 /**
0061  * @addtogroup ScoreMtxReqSurrender
0062  *
0063  * @{
0064  */
0065
0066 typedef enum {
0067   ScoreMtxReqSurrender_Pre_Protocol_None,
0068   ScoreMtxReqSurrender_Pre_Protocol_Inherit,
0069   ScoreMtxReqSurrender_Pre_Protocol_Ceiling,
0070   ScoreMtxReqSurrender_Pre_Protocol_MrsP,
0071   ScoreMtxReqSurrender_Pre_Protocol_NA
0072 } ScoreMtxReqSurrender_Pre_Protocol;
0073
0074 typedef enum {
0075   ScoreMtxReqSurrender_Pre_Discipline_FIFO,
0076   ScoreMtxReqSurrender_Pre_Discipline_Priority,
0077   ScoreMtxReqSurrender_Pre_Discipline_NA
0078 } ScoreMtxReqSurrender_Pre_Discipline;
0079
0080 typedef enum {
0081   ScoreMtxReqSurrender_Pre_Recursive_Allowed,
0082   ScoreMtxReqSurrender_Pre_Recursive_NotAllowed,
0083   ScoreMtxReqSurrender_Pre_Recursive_NA
0084 } ScoreMtxReqSurrender_Pre_Recursive;
0085
0086 typedef enum {
0087   ScoreMtxReqSurrender_Pre_OwnerCheck_Yes,
0088   ScoreMtxReqSurrender_Pre_OwnerCheck_No,
0089   ScoreMtxReqSurrender_Pre_OwnerCheck_NA
0090 } ScoreMtxReqSurrender_Pre_OwnerCheck;
0091
0092 typedef enum {
0093   ScoreMtxReqSurrender_Pre_Owner_None,
0094   ScoreMtxReqSurrender_Pre_Owner_Caller,
0095   ScoreMtxReqSurrender_Pre_Owner_Other,
0096   ScoreMtxReqSurrender_Pre_Owner_NA
0097 } ScoreMtxReqSurrender_Pre_Owner;
0098
0099 typedef enum {
0100   ScoreMtxReqSurrender_Pre_Nested_Yes,
0101   ScoreMtxReqSurrender_Pre_Nested_No,
0102   ScoreMtxReqSurrender_Pre_Nested_NA
0103 } ScoreMtxReqSurrender_Pre_Nested;
0104
0105 typedef enum {
0106   ScoreMtxReqSurrender_Pre_Blocked_Yes,
0107   ScoreMtxReqSurrender_Pre_Blocked_No,
0108   ScoreMtxReqSurrender_Pre_Blocked_NA
0109 } ScoreMtxReqSurrender_Pre_Blocked;
0110
0111 typedef enum {
0112   ScoreMtxReqSurrender_Pre_Priority_High,
0113   ScoreMtxReqSurrender_Pre_Priority_Equal,
0114   ScoreMtxReqSurrender_Pre_Priority_Low,
0115   ScoreMtxReqSurrender_Pre_Priority_NA
0116 } ScoreMtxReqSurrender_Pre_Priority;
0117
0118 typedef enum {
0119   ScoreMtxReqSurrender_Post_Status_Ok,
0120   ScoreMtxReqSurrender_Post_Status_NotOwner,
0121   ScoreMtxReqSurrender_Post_Status_NA
0122 } ScoreMtxReqSurrender_Post_Status;
0123
0124 typedef enum {
0125   ScoreMtxReqSurrender_Post_Owner_None,
0126   ScoreMtxReqSurrender_Post_Owner_Caller,
0127   ScoreMtxReqSurrender_Post_Owner_Other,
0128   ScoreMtxReqSurrender_Post_Owner_First,
0129   ScoreMtxReqSurrender_Post_Owner_NA
0130 } ScoreMtxReqSurrender_Post_Owner;
0131
0132 typedef enum {
0133   ScoreMtxReqSurrender_Post_Surrender_Nop,
0134   ScoreMtxReqSurrender_Post_Surrender_FIFO,
0135   ScoreMtxReqSurrender_Post_Surrender_Priority,
0136   ScoreMtxReqSurrender_Post_Surrender_PriorityInherit,
0137   ScoreMtxReqSurrender_Post_Surrender_MrsP,
0138   ScoreMtxReqSurrender_Post_Surrender_NA
0139 } ScoreMtxReqSurrender_Post_Surrender;
0140
0141 typedef enum {
0142   ScoreMtxReqSurrender_Post_Priority_Nop,
0143   ScoreMtxReqSurrender_Post_Priority_Low,
0144   ScoreMtxReqSurrender_Post_Priority_NA
0145 } ScoreMtxReqSurrender_Post_Priority;
0146
0147 /**
0148  * @brief Runs the parameterized test case.
0149  *
0150  * @param[in,out] tq_ctx is the thread queue context.
0151  */
0152 void ScoreMtxReqSurrender_Run( TQMtxContext *tq_ctx );
0153
0154 /** @} */
0155
0156 #ifdef __cplusplus
0157 }
0158 #endif
0159
0160 #endif /* _TR_MTX_SURRENDER_H */