a2da33d6df30c86c1bd546468a5033c9478dcd5e
[dahdi/tools.git] / xpp / oct612x / include / octdef.h
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: octdef.h
4
5     Copyright (c) 2001-2007 Octasic Inc.
6
7 Description: 
8
9         Common system definitions.
10
11 This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API  is 
12 free software; you can redistribute it and/or modify it under the terms of 
13 the GNU General Public License as published by the Free Software Foundation; 
14 either version 2 of the License, or (at your option) any later version.
15
16 The OCT6100 GPL API is distributed in the hope that it will be useful, but 
17 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
18 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
19 for more details. 
20
21 You should have received a copy of the GNU General Public License 
22 along with the OCT6100 GPL API; if not, write to the Free Software 
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24
25 $Octasic_Release: OCT612xAPI-01.00-PR49 $
26
27 $Octasic_Revision: 12 $
28
29 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
30
31 #ifndef __OCTDEF_H__
32 #define __OCTDEF_H__
33
34 /*--------------------------------------------------------------------------
35         C language
36 ----------------------------------------------------------------------------*/
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /*****************************  INCLUDE FILES  *******************************/
43
44 /*--------------------------------------------------------------------------
45         Get Platform Dependency headers 
46 ----------------------------------------------------------------------------*/
47 #include "octosdependant.h"
48
49
50 /*--------------------------------------------------------------------------
51         Common Type definitions
52 ----------------------------------------------------------------------------*/
53 #include "octtype.h"
54
55 /*****************************  DEFINES  *************************************/
56
57 /* List of functions to skip compiling since we don't use them */
58 #include "digium_unused.h"
59
60
61
62 /*--------------------------------------------------------------------------
63         Miscellaneous constants
64 ----------------------------------------------------------------------------*/
65
66 #ifndef PROTO
67 #define PROTO extern
68 #endif
69
70 /* Generic return codes. */
71 #define cOCTDEF_RC_OK           0               /* Generic Ok */
72 #define cOCTDEF_RC_ERROR        1               /* Generic Error */
73
74 /* Default return values of all OCTAPI functions. */
75 #ifndef GENERIC_OK
76 #define GENERIC_OK                      0x00000000
77 #endif
78
79 #ifndef GENERIC_ERROR
80 #define GENERIC_ERROR           0x00000001
81 #endif
82
83 #ifndef GENERIC_BAD_PARAM
84 #define GENERIC_BAD_PARAM       0x00000002
85 #endif
86
87 /* Defines of boolean expressions (TRUE/FALSE) */
88 #ifndef FALSE
89 #define FALSE (BOOL)0
90 #endif
91
92 #ifndef TRUE
93 #define TRUE  (BOOL)1
94 #endif
95
96 /*--------------------------------------------------------------------------
97         DLL Import-Export
98 ----------------------------------------------------------------------------*/
99
100 #ifdef OCT_WINENV
101 #define DLLIMP  __declspec( dllimport )
102 #define DLLEXP  __declspec( dllexport ) 
103 #else
104 #define DLLIMP  
105 #define DLLEXP  
106 #endif
107
108 /*--------------------------------------------------------------------------
109         C language
110 ----------------------------------------------------------------------------*/
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116 #endif /* __OCTDEF_H__ */