testsuites/validation/tr-mtx-seize-wait.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup ScoreMtxReqSeizeWait
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_SEIZE_WAIT_H
0052 #define _TR_MTX_SEIZE_WAIT_H
0053
0054 #include "tx-thread-queue.h"
0055
0056 #ifdef __cplusplus
0057 extern "C" {
0058 #endif
0059
0060 /**
0061  * @addtogroup ScoreMtxReqSeizeWait
0062  *
0063  * @{
0064  */
0065
0066 typedef enum {
0067   ScoreMtxReqSeizeWait_Pre_Protocol_None,
0068   ScoreMtxReqSeizeWait_Pre_Protocol_Inherit,
0069   ScoreMtxReqSeizeWait_Pre_Protocol_Ceiling,
0070   ScoreMtxReqSeizeWait_Pre_Protocol_MrsP,
0071   ScoreMtxReqSeizeWait_Pre_Protocol_NA
0072 } ScoreMtxReqSeizeWait_Pre_Protocol;
0073
0074 typedef enum {
0075   ScoreMtxReqSeizeWait_Pre_Discipline_FIFO,
0076   ScoreMtxReqSeizeWait_Pre_Discipline_Priority,
0077   ScoreMtxReqSeizeWait_Pre_Discipline_NA
0078 } ScoreMtxReqSeizeWait_Pre_Discipline;
0079
0080 typedef enum {
0081   ScoreMtxReqSeizeWait_Pre_DeadlockResult_Status,
0082   ScoreMtxReqSeizeWait_Pre_DeadlockResult_Fatal,
0083   ScoreMtxReqSeizeWait_Pre_DeadlockResult_NA
0084 } ScoreMtxReqSeizeWait_Pre_DeadlockResult;
0085
0086 typedef enum {
0087   ScoreMtxReqSeizeWait_Pre_Recursive_Allowed,
0088   ScoreMtxReqSeizeWait_Pre_Recursive_Deadlock,
0089   ScoreMtxReqSeizeWait_Pre_Recursive_NA
0090 } ScoreMtxReqSeizeWait_Pre_Recursive;
0091
0092 typedef enum {
0093   ScoreMtxReqSeizeWait_Pre_Owner_None,
0094   ScoreMtxReqSeizeWait_Pre_Owner_Caller,
0095   ScoreMtxReqSeizeWait_Pre_Owner_Other,
0096   ScoreMtxReqSeizeWait_Pre_Owner_Deadlock,
0097   ScoreMtxReqSeizeWait_Pre_Owner_NA
0098 } ScoreMtxReqSeizeWait_Pre_Owner;
0099
0100 typedef enum {
0101   ScoreMtxReqSeizeWait_Pre_Priority_High,
0102   ScoreMtxReqSeizeWait_Pre_Priority_Equal,
0103   ScoreMtxReqSeizeWait_Pre_Priority_Low,
0104   ScoreMtxReqSeizeWait_Pre_Priority_NA
0105 } ScoreMtxReqSeizeWait_Pre_Priority;
0106
0107 typedef enum {
0108   ScoreMtxReqSeizeWait_Post_Status_Ok,
0109   ScoreMtxReqSeizeWait_Post_Status_MutexCeilingViolated,
0110   ScoreMtxReqSeizeWait_Post_Status_DeadlockStatus,
0111   ScoreMtxReqSeizeWait_Post_Status_DeadlockFatal,
0112   ScoreMtxReqSeizeWait_Post_Status_NA
0113 } ScoreMtxReqSeizeWait_Post_Status;
0114
0115 typedef enum {
0116   ScoreMtxReqSeizeWait_Post_Enqueued_No,
0117   ScoreMtxReqSeizeWait_Post_Enqueued_FIFO,
0118   ScoreMtxReqSeizeWait_Post_Enqueued_Priority,
0119   ScoreMtxReqSeizeWait_Post_Enqueued_PriorityInherit,
0120   ScoreMtxReqSeizeWait_Post_Enqueued_PriorityCeiling,
0121   ScoreMtxReqSeizeWait_Post_Enqueued_PriorityMrsP,
0122   ScoreMtxReqSeizeWait_Post_Enqueued_NA
0123 } ScoreMtxReqSeizeWait_Post_Enqueued;
0124
0125 typedef enum {
0126   ScoreMtxReqSeizeWait_Post_Owner_Other,
0127   ScoreMtxReqSeizeWait_Post_Owner_Caller,
0128   ScoreMtxReqSeizeWait_Post_Owner_None,
0129   ScoreMtxReqSeizeWait_Post_Owner_NA
0130 } ScoreMtxReqSeizeWait_Post_Owner;
0131
0132 typedef enum {
0133   ScoreMtxReqSeizeWait_Post_Priority_Nop,
0134   ScoreMtxReqSeizeWait_Post_Priority_Ceiling,
0135   ScoreMtxReqSeizeWait_Post_Priority_NA
0136 } ScoreMtxReqSeizeWait_Post_Priority;
0137
0138 /**
0139  * @brief Runs the parameterized test case.
0140  *
0141  * @param[in,out] tq_ctx is the thread queue context.
0142  */
0143 void ScoreMtxReqSeizeWait_Run( TQMtxContext *tq_ctx );
0144
0145 /** @} */
0146
0147 #ifdef __cplusplus
0148 }
0149 #endif
0150
0151 #endif /* _TR_MTX_SEIZE_WAIT_H */