testsuites/validation/tr-object-ident.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RtemsReqIdent
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_OBJECT_IDENT_H
0052 #define _TR_OBJECT_IDENT_H
0053
0054 #include <rtems.h>
0055
0056 #ifdef __cplusplus
0057 extern "C" {
0058 #endif
0059
0060 /**
0061  * @addtogroup RtemsReqIdent
0062  *
0063  * @{
0064  */
0065
0066 typedef enum {
0067   RtemsReqIdent_Pre_Name_Invalid,
0068   RtemsReqIdent_Pre_Name_Valid,
0069   RtemsReqIdent_Pre_Name_NA
0070 } RtemsReqIdent_Pre_Name;
0071
0072 typedef enum {
0073   RtemsReqIdent_Pre_Node_Local,
0074   RtemsReqIdent_Pre_Node_Remote,
0075   RtemsReqIdent_Pre_Node_Invalid,
0076   RtemsReqIdent_Pre_Node_SearchAll,
0077   RtemsReqIdent_Pre_Node_SearchOther,
0078   RtemsReqIdent_Pre_Node_SearchLocal,
0079   RtemsReqIdent_Pre_Node_NA
0080 } RtemsReqIdent_Pre_Node;
0081
0082 typedef enum {
0083   RtemsReqIdent_Pre_Id_Valid,
0084   RtemsReqIdent_Pre_Id_Null,
0085   RtemsReqIdent_Pre_Id_NA
0086 } RtemsReqIdent_Pre_Id;
0087
0088 typedef enum {
0089   RtemsReqIdent_Post_Status_Ok,
0090   RtemsReqIdent_Post_Status_InvAddr,
0091   RtemsReqIdent_Post_Status_InvName,
0092   RtemsReqIdent_Post_Status_InvNode,
0093   RtemsReqIdent_Post_Status_NA
0094 } RtemsReqIdent_Post_Status;
0095
0096 typedef enum {
0097   RtemsReqIdent_Post_Id_Nop,
0098   RtemsReqIdent_Post_Id_Null,
0099   RtemsReqIdent_Post_Id_LocalObj,
0100   RtemsReqIdent_Post_Id_RemoteObj,
0101   RtemsReqIdent_Post_Id_NA
0102 } RtemsReqIdent_Post_Id;
0103
0104 /**
0105  * @brief Runs the parameterized test case.
0106  *
0107  * @param id_local_object is the identifier of an active object of the class
0108  *   under test.
0109  *
0110  * @param name_local_object is the name of the active object of the class under
0111  *   test.
0112  *
0113  * @param action is the action handler.
0114  */
0115 void RtemsReqIdent_Run(
0116   rtems_id             id_local_object,
0117   rtems_name           name_local_object,
0118   rtems_status_code ( *action )( rtems_name, uint32_t, rtems_id * )
0119 );
0120
0121 /** @} */
0122
0123 #ifdef __cplusplus
0124 }
0125 #endif
0126
0127 #endif /* _TR_OBJECT_IDENT_H */