• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 kernelspace DLL Communication Abstraction Layer module
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: EplDllkCal.h,v $
53 
54                 $Author: D.Krueger $
55 
56                 $Revision: 1.6 $  $Date: 2008/11/13 17:13:09 $
57 
58                 $State: Exp $
59 
60                 Build Environment:
61                     GCC V3.4
62 
63   -------------------------------------------------------------------------
64 
65   Revision History:
66 
67   2006/06/13 d.k.:   start of the implementation, version 1.00
68 
69 ****************************************************************************/
70 
71 #ifndef _EPL_DLLKCAL_H_
72 #define _EPL_DLLKCAL_H_
73 
74 #include "../EplDll.h"
75 #include "../EplEvent.h"
76 
77 //---------------------------------------------------------------------------
78 // const defines
79 //---------------------------------------------------------------------------
80 
81 //---------------------------------------------------------------------------
82 // typedef
83 //---------------------------------------------------------------------------
84 
85 typedef struct {
86 	unsigned long m_ulCurTxFrameCountGen;
87 	unsigned long m_ulCurTxFrameCountNmt;
88 	unsigned long m_ulCurRxFrameCount;
89 	unsigned long m_ulMaxTxFrameCountGen;
90 	unsigned long m_ulMaxTxFrameCountNmt;
91 	unsigned long m_ulMaxRxFrameCount;
92 
93 } tEplDllkCalStatistics;
94 
95 //---------------------------------------------------------------------------
96 // function prototypes
97 //---------------------------------------------------------------------------
98 
99 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
100 
101 tEplKernel EplDllkCalAddInstance(void);
102 
103 tEplKernel EplDllkCalDelInstance(void);
104 
105 tEplKernel EplDllkCalAsyncGetTxCount(tEplDllAsyncReqPriority * pPriority_p,
106 				     unsigned int *puiCount_p);
107 tEplKernel EplDllkCalAsyncGetTxFrame(void *pFrame_p,
108 				     unsigned int *puiFrameSize_p,
109 				     tEplDllAsyncReqPriority Priority_p);
110 // only frames with registered AsndServiceIds are passed to CAL
111 tEplKernel EplDllkCalAsyncFrameReceived(tEplFrameInfo * pFrameInfo_p);
112 
113 tEplKernel EplDllkCalAsyncSend(tEplFrameInfo * pFrameInfo_p,
114 			       tEplDllAsyncReqPriority Priority_p);
115 
116 tEplKernel EplDllkCalAsyncClearBuffer(void);
117 
118 tEplKernel EplDllkCalGetStatistics(tEplDllkCalStatistics ** ppStatistics);
119 
120 tEplKernel EplDllkCalProcess(tEplEvent * pEvent_p);
121 
122 #if (((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
123 
124 tEplKernel EplDllkCalAsyncClearQueues(void);
125 
126 tEplKernel EplDllkCalIssueRequest(tEplDllReqServiceId Service_p,
127 				  unsigned int uiNodeId_p, BYTE bSoaFlag1_p);
128 
129 tEplKernel EplDllkCalAsyncGetSoaRequest(tEplDllReqServiceId * pReqServiceId_p,
130 					unsigned int *puiNodeId_p);
131 
132 tEplKernel EplDllkCalAsyncSetPendingRequests(unsigned int uiNodeId_p,
133 					     tEplDllAsyncReqPriority
134 					     AsyncReqPrio_p,
135 					     unsigned int uiCount_p);
136 
137 #endif //(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
138 
139 #endif // #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
140 
141 #endif // #ifndef _EPL_DLLKCAL_H_
142