testsuites/validation/tr-tq-flush-priority.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup ScoreTqReqFlushPriority
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_TQ_FLUSH_PRIORITY_H
0052 #define _TR_TQ_FLUSH_PRIORITY_H
0053
0054 #include "tx-thread-queue.h"
0055
0056 #ifdef __cplusplus
0057 extern "C" {
0058 #endif
0059
0060 /**
0061  * @addtogroup ScoreTqReqFlushPriority
0062  *
0063  * @{
0064  */
0065
0066 typedef enum {
0067   ScoreTqReqFlushPriority_Pre_Queue_Empty,
0068   ScoreTqReqFlushPriority_Pre_Queue_NonEmpty,
0069   ScoreTqReqFlushPriority_Pre_Queue_NA
0070 } ScoreTqReqFlushPriority_Pre_Queue;
0071
0072 typedef enum {
0073   ScoreTqReqFlushPriority_Post_Operation_Nop,
0074   ScoreTqReqFlushPriority_Post_Operation_TryExtract,
0075   ScoreTqReqFlushPriority_Post_Operation_NA
0076 } ScoreTqReqFlushPriority_Post_Operation;
0077
0078 /**
0079  * @brief Runs the parameterized test case.
0080  *
0081  * @param[in,out] tq_ctx is the thread queue test context.
0082  *
0083  * @param supports_multiple_priority_queues is true, if the object using the
0084  *   thread queue supports multiple priority queues, otherwise it is false.
0085  */
0086 void ScoreTqReqFlushPriority_Run(
0087   TQContext *tq_ctx,
0088   bool       supports_multiple_priority_queues
0089 );
0090
0091 /** @} */
0092
0093 #ifdef __cplusplus
0094 }
0095 #endif
0096
0097 #endif /* _TR_TQ_FLUSH_PRIORITY_H */