1 /*
2 * Copyright (c) 2013-2014, Texas Instruments Incorporated
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
33 /*
34 * ======== GateMutex.h ========
35 *
36 * Gate based on Mutex
37 *
38 */
40 #ifndef GATEMUTEX_H_0x72D0
41 #define GATEMUTEX_H_0x72D0
44 #if defined (__cplusplus)
45 extern "C" {
46 #endif
49 /* =============================================================================
50 * Status codes
51 * =============================================================================
52 */
53 /*!
54 * @def GateMutex_E_INVALIDARG
55 * @brief Argument passed to a function is invalid.
56 */
57 #define GateMutex_E_INVALIDARG -1
59 /*!
60 * @def GateMutex_E_MEMORY
61 * @brief Memory allocation failed.
62 */
63 #define GateMutex_E_MEMORY -2
65 /*!
66 * @def GateMutex_E_BUSY
67 * @brief The name is already registered or not.
68 */
69 #define GateMutex_E_BUSY -3
71 /*!
72 * @def GateMutex_E_FAIL
73 * @brief Generic failure.
74 */
75 #define GateMutex_E_FAIL -4
77 /*!
78 * @def GateMutex_E_NOTFOUND
79 * @brief Name not found in the nameserver.
80 */
81 #define GateMutex_E_NOTFOUND -5
83 /*!
84 * @def GateMutex_E_INVALIDSTATE
85 * @brief Module is not initialized.
86 */
87 #define GateMutex_E_INVALIDSTATE -6
89 /*!
90 * @def GateMutex_E_INUSE
91 * @brief Indicates that the instance is in use.
92 */
93 #define GateMutex_E_INUSE -7
95 /*!
96 * @def GateMutex_S_SUCCESS
97 * @brief Operation successful.
98 */
99 #define GateMutex_S_SUCCESS 0
102 /* =============================================================================
103 * Macros and types
104 * =============================================================================
105 */
106 /*! @brief Object for Gate Mutex */
107 typedef struct GateMutex_Object GateMutex_Object;
109 /*! @brief Handle for Gate Mutex */
110 typedef struct GateMutex_Object * GateMutex_Handle;
112 /*! No parameters for GateMutex creation */
113 typedef Void GateMutex_Params;
115 /* =============================================================================
116 * APIs
117 * =============================================================================
118 */
119 /* Function to create a GateMutex */
120 GateMutex_Handle
121 GateMutex_create (const GateMutex_Params * params, Error_Block *eb);
123 /* Function to delete a Gate Mutex */
124 Int GateMutex_delete (GateMutex_Handle * gmHandle);
127 #if defined (__cplusplus)
128 }
129 #endif /* defined (__cplusplus) */
131 #endif /* GATEMUTEX_H_0x72D0 */