Staging: add epl stack
[firefly-linux-kernel-4.4.55.git] / drivers / staging / epl / EplTarget.h
1 /****************************************************************************
2
3   (c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29
4       www.systec-electronic.com
5
6   Project:      openPOWERLINK
7
8   Description:  include file for target api function
9
10   License:
11
12     Redistribution and use in source and binary forms, with or without
13     modification, are permitted provided that the following conditions
14     are met:
15
16     1. Redistributions of source code must retain the above copyright
17        notice, this list of conditions and the following disclaimer.
18
19     2. Redistributions in binary form must reproduce the above copyright
20        notice, this list of conditions and the following disclaimer in the
21        documentation and/or other materials provided with the distribution.
22
23     3. Neither the name of SYSTEC electronic GmbH nor the names of its
24        contributors may be used to endorse or promote products derived
25        from this software without prior written permission. For written
26        permission, please contact info@systec-electronic.com.
27
28     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
31     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
32     COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
33     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
36     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
38     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39     POSSIBILITY OF SUCH DAMAGE.
40
41     Severability Clause:
42
43         If a provision of this License is or becomes illegal, invalid or
44         unenforceable in any jurisdiction, that shall not affect:
45         1. the validity or enforceability in that jurisdiction of any other
46            provision of this License; or
47         2. the validity or enforceability in other jurisdictions of that or
48            any other provision of this License.
49
50   -------------------------------------------------------------------------
51
52                 $RCSfile: EplTarget.h,v $
53
54                 $Author: D.Krueger $
55
56                 $Revision: 1.5 $  $Date: 2008/04/17 21:36:32 $
57
58                 $State: Exp $
59
60                 Build Environment:
61                     GCC V3.4
62
63   -------------------------------------------------------------------------
64
65   Revision History:
66
67   2005/12/05 -as:   start of the implementation, version 1.00
68
69
70 ****************************************************************************/
71
72 #ifndef _EPLTARGET_H_
73 #define _EPLTARGET_H_
74
75
76 //---------------------------------------------------------------------------
77 // const defines
78 //---------------------------------------------------------------------------
79 // =========================================================================
80 // macros for memory access (depends on target system)
81 // =========================================================================
82
83 // NOTE:
84 // The following macros are used to combine standard library definitions. Some
85 // applications needs to use one common library function (e.g. memcpy()). So
86 // you can set (or change) it here.
87
88 #if (TARGET_SYSTEM == _WIN32_)
89
90     #define _WIN32_WINDOWS 0x0401
91     #define _WIN32_WINNT   0x0400
92
93     #include <stdlib.h>
94     #include <stdio.h>
95
96     //29.11.2004 f.j. sonst ist memcpy und memset unbekannt
97     #include <string.h>
98
99     #define EPL_MEMCPY(dst,src,siz)     memcpy((void*)(dst),(const void*)(src),(size_t)(siz));
100     #define EPL_MEMSET(dst,val,siz)     memset((void*)(dst),(int)(val),(size_t)(siz));
101
102     // f.j.: die Funktionen für <MemAlloc> und <MemFree> sind in WinMem.c definiert
103     //definition der Prototypen
104     void FAR*  MemAlloc (DWORD dwMemSize_p);
105     void       MemFree (void FAR* pMem_p);
106
107     #define EPL_MALLOC(siz)             malloc((size_t)(siz))
108     #define EPL_FREE(ptr)               free((void *)ptr)
109
110     #ifndef PRINTF0
111         void trace (const char* fmt, ...);
112         #define PRINTF                      TRACE
113         #define PRINTF0(arg)                TRACE0(arg)
114         #define PRINTF1(arg,p1)             TRACE1(arg,p1)
115         #define PRINTF2(arg,p1,p2)          TRACE2(arg,p1,p2)
116         #define PRINTF3(arg,p1,p2,p3)       TRACE3(arg,p1,p2,p3)
117         #define PRINTF4(arg,p1,p2,p3,p4)    TRACE4(arg,p1,p2,p3,p4)
118         //#define PRINTF                      printf
119         //#define PRINTF0(arg)                PRINTF(arg)
120         //#define PRINTF1(arg,p1)             PRINTF(arg,p1)
121         //#define PRINTF2(arg,p1,p2)          PRINTF(arg,p1,p2)
122         //#define PRINTF3(arg,p1,p2,p3)       PRINTF(arg,p1,p2,p3)
123         //#define PRINTF4(arg,p1,p2,p3,p4)    PRINTF(arg,p1,p2,p3,p4)
124     #endif
125
126     #ifdef ASSERTMSG
127         #undef ASSERTMSG
128     #endif
129
130     #define ASSERTMSG(expr,string)  if (!(expr)) { \
131                                         MessageBox (NULL, string, "Assertion failed", MB_OK | MB_ICONERROR); \
132                                         exit (-1);}
133
134
135
136 #elif (TARGET_SYSTEM == _NO_OS_)
137
138     #include <stdlib.h>
139     #include <stdio.h>
140
141     //29.11.2004 f.j. sonst ist memcpy und memset unbekannt
142 //    #include <string.h>
143
144     #define EPL_MEMCPY(dst,src,siz)     memcpy((void*)(dst),(const void*)(src),(size_t)(siz));
145     #define EPL_MEMSET(dst,val,siz)     memset((void*)(dst),(int)(val),(size_t)(siz));
146
147     #define EPL_MALLOC(siz)             malloc((size_t)(siz))
148     #define EPL_FREE(ptr)               free((void *)ptr)
149
150     #ifndef PRINTF0
151         #define PRINTF                      TRACE
152         #define PRINTF0(arg)                TRACE0(arg)
153         #define PRINTF1(arg,p1)             TRACE1(arg,p1)
154         #define PRINTF2(arg,p1,p2)          TRACE2(arg,p1,p2)
155         #define PRINTF3(arg,p1,p2,p3)       TRACE3(arg,p1,p2,p3)
156         #define PRINTF4(arg,p1,p2,p3,p4)    TRACE4(arg,p1,p2,p3,p4)
157         //#define PRINTF                      printf
158         //#define PRINTF0(arg)                PRINTF(arg)
159         //#define PRINTF1(arg,p1)             PRINTF(arg,p1)
160         //#define PRINTF2(arg,p1,p2)          PRINTF(arg,p1,p2)
161         //#define PRINTF3(arg,p1,p2,p3)       PRINTF(arg,p1,p2,p3)
162         //#define PRINTF4(arg,p1,p2,p3,p4)    PRINTF(arg,p1,p2,p3,p4)
163     #endif
164
165
166 #elif (TARGET_SYSTEM == _LINUX_)
167
168     #ifndef __KERNEL__
169         #include <stdlib.h>
170         #include <stdio.h>
171     #else
172 //        #include <linux/config.h>
173         #include <linux/module.h>
174         #include <linux/kernel.h>
175         #include <linux/init.h>
176         #include <linux/errno.h>
177         #include <linux/major.h>
178         #include <linux/version.h>
179     #endif
180
181     //29.11.2004 f.j. sonst ist memcpy und memset unbekannt
182 //    #include <string.h>
183
184     #define EPL_MEMCPY(dst,src,siz)     memcpy((void*)(dst),(const void*)(src),(size_t)(siz));
185     #define EPL_MEMSET(dst,val,siz)     memset((void*)(dst),(int)(val),(size_t)(siz));
186
187     #ifndef __KERNEL__
188         #define EPL_MALLOC(siz)             malloc((size_t)(siz))
189         #define EPL_FREE(ptr)               free((void *)ptr)
190     #else
191         #define EPL_MALLOC(siz)             kmalloc((size_t)(siz), GFP_KERNEL)
192         #define EPL_FREE(ptr)               kfree((void *)ptr)
193     #endif
194
195     #ifndef PRINTF0
196         #define PRINTF                      TRACE
197         #define PRINTF0(arg)                TRACE0(arg)
198         #define PRINTF1(arg,p1)             TRACE1(arg,p1)
199         #define PRINTF2(arg,p1,p2)          TRACE2(arg,p1,p2)
200         #define PRINTF3(arg,p1,p2,p3)       TRACE3(arg,p1,p2,p3)
201         #define PRINTF4(arg,p1,p2,p3,p4)    TRACE4(arg,p1,p2,p3,p4)
202         //#define PRINTF                      printf
203         //#define PRINTF0(arg)                PRINTF(arg)
204         //#define PRINTF1(arg,p1)             PRINTF(arg,p1)
205         //#define PRINTF2(arg,p1,p2)          PRINTF(arg,p1,p2)
206         //#define PRINTF3(arg,p1,p2,p3)       PRINTF(arg,p1,p2,p3)
207         //#define PRINTF4(arg,p1,p2,p3,p4)    PRINTF(arg,p1,p2,p3,p4)
208     #endif
209
210
211 #endif
212
213 #define EPL_TGT_INTMASK_ETH     0x0001  // ethernet interrupt
214 #define EPL_TGT_INTMASK_DMA     0x0002  // DMA interrupt
215
216 //---------------------------------------------------------------------------
217 // typedef
218 //---------------------------------------------------------------------------
219
220
221 //---------------------------------------------------------------------------
222 // function prototypes
223 //---------------------------------------------------------------------------
224
225 // currently no Timer functions are needed by EPL stack
226 // so they are not implemented yet
227 //void  PUBLIC TgtTimerInit(void);
228 //DWORD PUBLIC TgtGetTickCount(void);
229 //void PUBLIC TgtGetNetTime(tEplNetTime * pNetTime_p);
230
231 // functions for ethernet driver
232 tEplKernel PUBLIC TgtInitEthIsr(void);
233 void PUBLIC TgtFreeEthIsr(void);
234 void  PUBLIC  TgtEnableGlobalInterrupt(BYTE fEnable_p);
235 void PUBLIC TgtEnableEthInterrupt0(BYTE fEnable_p, unsigned int uiInterruptMask_p);
236 void PUBLIC TgtEnableEthInterrupt1(BYTE fEnable_p, unsigned int uiInterruptMask_p);
237
238 #endif  // #ifndef _EPLTARGET_H_
239
240