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

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup ScoreMtxReqSeizeTry
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_TRY_H
0052 #define _TR_MTX_SEIZE_TRY_H
0053
0054 #include "tx-thread-queue.h"
0055
0056 #ifdef __cplusplus
0057 extern "C" {
0058 #endif
0059
0060 /**
0061  * @addtogroup ScoreMtxReqSeizeTry
0062  *
0063  * @{
0064  */
0065
0066 typedef enum {
0067   ScoreMtxReqSeizeTry_Pre_Protocol_Ceiling,
0068   ScoreMtxReqSeizeTry_Pre_Protocol_MrsP,
0069   ScoreMtxReqSeizeTry_Pre_Protocol_Other,
0070   ScoreMtxReqSeizeTry_Pre_Protocol_NA
0071 } ScoreMtxReqSeizeTry_Pre_Protocol;
0072
0073 typedef enum {
0074   ScoreMtxReqSeizeTry_Pre_Discipline_FIFO,
0075   ScoreMtxReqSeizeTry_Pre_Discipline_Priority,
0076   ScoreMtxReqSeizeTry_Pre_Discipline_NA
0077 } ScoreMtxReqSeizeTry_Pre_Discipline;
0078
0079 typedef enum {
0080   ScoreMtxReqSeizeTry_Pre_Recursive_Allowed,
0081   ScoreMtxReqSeizeTry_Pre_Recursive_Unavailable,
0082   ScoreMtxReqSeizeTry_Pre_Recursive_Deadlock,
0083   ScoreMtxReqSeizeTry_Pre_Recursive_NA
0084 } ScoreMtxReqSeizeTry_Pre_Recursive;
0085
0086 typedef enum {
0087   ScoreMtxReqSeizeTry_Pre_Owner_None,
0088   ScoreMtxReqSeizeTry_Pre_Owner_Caller,
0089   ScoreMtxReqSeizeTry_Pre_Owner_Other,
0090   ScoreMtxReqSeizeTry_Pre_Owner_NA
0091 } ScoreMtxReqSeizeTry_Pre_Owner;
0092
0093 typedef enum {
0094   ScoreMtxReqSeizeTry_Pre_Priority_High,
0095   ScoreMtxReqSeizeTry_Pre_Priority_Equal,
0096   ScoreMtxReqSeizeTry_Pre_Priority_Low,
0097   ScoreMtxReqSeizeTry_Pre_Priority_NA
0098 } ScoreMtxReqSeizeTry_Pre_Priority;
0099
0100 typedef enum {
0101   ScoreMtxReqSeizeTry_Post_Status_Ok,
0102   ScoreMtxReqSeizeTry_Post_Status_MutexCeilingViolated,
0103   ScoreMtxReqSeizeTry_Post_Status_Deadlock,
0104   ScoreMtxReqSeizeTry_Post_Status_Unavailable,
0105   ScoreMtxReqSeizeTry_Post_Status_NA
0106 } ScoreMtxReqSeizeTry_Post_Status;
0107
0108 typedef enum {
0109   ScoreMtxReqSeizeTry_Post_Owner_Other,
0110   ScoreMtxReqSeizeTry_Post_Owner_Caller,
0111   ScoreMtxReqSeizeTry_Post_Owner_None,
0112   ScoreMtxReqSeizeTry_Post_Owner_NA
0113 } ScoreMtxReqSeizeTry_Post_Owner;
0114
0115 typedef enum {
0116   ScoreMtxReqSeizeTry_Post_Priority_Nop,
0117   ScoreMtxReqSeizeTry_Post_Priority_Ceiling,
0118   ScoreMtxReqSeizeTry_Post_Priority_NA
0119 } ScoreMtxReqSeizeTry_Post_Priority;
0120
0121 /**
0122  * @brief Runs the parameterized test case.
0123  *
0124  * @param[in,out] tq_ctx is the thread queue context.
0125  */
0126 void ScoreMtxReqSeizeTry_Run( TQMtxContext *tq_ctx );
0127
0128 /** @} */
0129
0130 #ifdef __cplusplus
0131 }
0132 #endif
0133
0134 #endif /* _TR_MTX_SEIZE_TRY_H */