SysLink API Reference  2.21.03.11
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
GateMonitor.h
Go to the documentation of this file.
1 
8 /*
9  * ============================================================================
10  *
11  * Copyright (c) 2008-2012, Texas Instruments Incorporated
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * * Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * * Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  *
24  * * Neither the name of Texas Instruments Incorporated nor the names of
25  * its contributors may be used to endorse or promote products derived
26  * from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
30  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
32  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
35  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
36  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
37  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
38  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  * Contact information for paper mail:
40  * Texas Instruments
41  * Post Office Box 655303
42  * Dallas, Texas 75265
43  * Contact information:
44  * http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
45  * DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
46  * ============================================================================
47  *
48  */
49 
50 
51 #ifndef GATEMONITOR_H_0x189E
52 #define GATEMONITOR_H_0x189E
53 
54 
55 #if defined (__cplusplus)
56 extern "C" {
57 #endif
58 
59 
60 /* =============================================================================
61  * Status codes
62  * =============================================================================
63  */
68 #define GateMonitor_E_INVALIDARG -1
69 
74 #define GateMonitor_E_MEMORY -2
75 
80 #define GateMonitor_E_BUSY -3
81 
86 #define GateMonitor_E_FAIL -4
87 
92 #define GateMonitor_E_NOTFOUND -5
93 
98 #define GateMonitor_E_INVALIDSTATE -6
99 
104 #define GateMonitor_E_INUSE -7
105 
110 #define GateMonitor_E_HANDLE -8
111 
116 #define GateMonitor_S_SUCCESS 0
117 
118 
119 /* =============================================================================
120  * Macros and types
121  * =============================================================================
122  */
124 typedef struct GateMonitor_Object GateMonitor_Object;
125 
127 typedef GateMonitor_Object * GateMonitor_Handle;
128 
130 typedef Void GateMonitor_Params;
131 
132 
133 /* =============================================================================
134  * APIs
135  * =============================================================================
136  */
137 /* Function to create a GateMonitor */
138 GateMonitor_Handle GateMonitor_create (const GateMonitor_Params * params);
139 
140 /* Function to delete a GateMonitor */
141 Int GateMonitor_delete (GateMonitor_Handle * handle);
142 
143 
144 #if defined (__cplusplus)
145 }
146 #endif /* defined (__cplusplus) */
147 
148 
149 #endif /* GATEMONITOR_H_0x188E */
Copyright 2014, Texas Instruments Incorporated